Skip to content

docs: fix 13 typos in code comments and docblocks - #10

Open
Avicennasis wants to merge 1 commit into
Open-Web-Analytics:masterfrom
Avicennasis:docs/fix-typos
Open

Avicennasis wants to merge 1 commit into
Open-Web-Analytics:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Spelling and grammar fixes in PHP comments and docblocks only. No identifier, no translation string and no behaviour is changed.

Reported by an automated spell scan (7 applied, 2 declined)

  • src/module.php: // we need ot init the settings page objects here -> to
  • src/module.php: // as they are needed by two the callbacks to seperate WordPress Hooks ... -> by the two callbacks to separate ... (the reported seperate, plus the transposed two the on the same line)
  • src/module.php: // iterate throught group of settings fields. -> through
  • src/module.php: // iterate throug thhe fields in the group -> through the
  • src/module.php: // regsiter the settings pages with WordPress -> register
  • src/module.php: * Inititalizes Settings Page Objects -> Initializes
  • src/settings/field.php: // name of the santizer callback to be used -> sanitizer

Two further reported items are not applied, because they are identifiers and renaming them would be a breaking API change:

  • module::loadDependancies() in src/module.php
  • field::$santizer_callback in src/settings/field.php - only the comment above it is corrected, so the property name is untouched

Found alongside them, not in the original report (6)

  • owa-plugin.php: // bail if this isn't a request type that OWA needs ot be loaded on. -> to (the same ot typo as above)
  • owa-plugin.php: * Singelton -> Singleton
  • owa-plugin.php: // remove this if uneeded -> unneeded
  • owa-plugin.php: * Trackes new and edited post actions. -> Tracks
  • src/settings/page.php: // set a false value in case it's a boollean type -> boolean
  • src/settings/page.php: // because it doesn't allows for filtered output -> doesn't allow

The copyright/licence header in owa-plugin.php is untouched. Each file was edited byte-wise with an occurrence-count and length-delta assertion, so the diff is exactly one line per fix (4 files, 13 insertions, 13 deletions).

Spelling and grammar corrections in PHP comments and docblocks only. No
identifiers, translation strings or behaviour are changed.

Deliberately left unchanged, because renaming them would be a breaking
API change:
  - module::loadDependancies()  (src/module.php)
  - field::$santizer_callback  (src/settings/field.php) - only the comment
    above it is corrected

Seven of these were reported by an automated scan; six more of the same
kind were found alongside them (owa-plugin.php: 'ot' -> 'to', 'Singelton',
'uneeded', 'Trackes'; settings/page.php: 'boollean', "doesn't allows").

Signed-off-by: Léon Avic Simmons <Avicennasis@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant