Page MenuHomePhabricator

"saneitize" spelling error in comment and code
Closed, InvalidPublic

Description

CirrusSearch

  • rECIR/includes/Job/CheckerJob.php
    • In comment: saneitizer
    • In code: SearchProfileService::SANEITIZER
    • Really?
  • rECIR/maintenance/SaneitizeJobs.php
    • subpage name
  • rECIR/includes/Maintenance/SaneitizeLoop.php
    • subpage name
  • rECIR/includes/Profile/SearchProfileServiceFactory.php

Apparently no external interface is relying on this word.

  • Three cheers to encapsulation.
  • Since it is a private ID, all related occurrences might be corrected simultaneously.
  • The entire bundle getting productive with updated spelling should work.

Event Timeline

Restricted Application added a subscriber: Aklapper. · View Herald Transcript

There is no English word saneitize, and at least confusing.

Someone might attempted to make a joke, but such jokes are not subject to naming of things in programming.

They are error-prone, since everybody else would assume regular spelling and cause bad access.

In gerrit:590007 Ebernhardson commented 20 April 2020: Not a typo. This class does no sanitization

Well, if not a sanitizer then the name of this thing has been badly chosen. if it is not sanitizing then change all occurences into a better name.

There has been a patch uploaded in 2020, which needed to be abandoned and caused discussion. Misleading and misspelled names shall not cause extra efforts every six months. Funny joke, yes we all loughed, and now replace it by a more significant identifier.

Aklapper renamed this task from Insane spelling error in comment and code to saneitize should be spelled sanitize.Jan 4 2021, 11:49 AM

Just because a word doesn't exist, doesn't mean it shouldn't be used. That's how new words come about.

saneitize should be spelled sanitize

No it shouldn't.

If anything saneitize should become something like rationalize.

I don't care enough, and you'd have get the maintainers to actually change it.

Gehel subscribed.

The Saneitizer is a low level component that no one out of the Search Platform team should care about. The name make sense to the people who need to care about it, we're not going to spend any time renaming.

Aklapper renamed this task from saneitize should be spelled sanitize to "saneitize" spelling error in comment and code.Jan 4 2021, 6:02 PM