Skip to content

docs: fix 7 typos in comments and log messages - #353

Closed
Avicennasis wants to merge 1 commit into
AdguardTeam:masterfrom
Avicennasis:docs/fix-typos
Closed

docs: fix 7 typos in comments and log messages#353
Avicennasis wants to merge 1 commit into
AdguardTeam:masterfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown
Contributor

Type of Changes

  • 🐛 Bug fix
  • New feature
  • ⬆️ Dependencies update
  • 📝 Documentation update

Description

Fixes 7 typos in comments, JSDoc and two debug log strings. No logic changes.

  • src/ui/alert/AlertController.ts (line 156): comment collpased -> collapsed
  • src/ui/alert/AlertController.ts (line 171): comment within 2 sec of of mouseleave event -> within 2 sec of mouseleave event
  • src/proxy/ChildContextInjector.ts (line 18): JSDoc maps iframe elements to its contentDocument -> their contentDocument (the antecedent elements is plural)
  • src/messaging/InterContextMessageHub.ts (line 102): log.print('MesageHub: received a message from a port') -> MessageHub
  • src/messaging/InterContextMessageHub.ts (line 147): log.print('MesageHub: sending a message to a port') -> MessageHub
  • locales.ts (line 36): JSDoc Build query string for downloading tranlations -> translations
  • locales.ts (line 49): JSDoc Build form data for uploading tranlation -> translation

The two InterContextMessageHub changes are the only ones that touch executable lines: they are the text
inside log.print(...) debug messages, and they are already spelled MessageHub on lines 50 and 56 of the
same file, so this only makes the log output self-consistent. Worth a careful look all the same, since they
are string literals rather than comments. I grepped the whole repository (including test/) for MesageHub:
the two lines changed here are the only occurrences, so no test assertions or other call sites depend on the
old spelling.

Testing Instructions

No runtime behaviour changes, so there is nothing to test functionally. git diff shows 7 changed lines
across 4 files, all inside comments or debug log strings.

Browser Support

  • All browsers
  • Chrome
  • Firefox
  • Opera
  • Edge
  • Other

Manifest version:

  • MV2
  • MV3

(N/A - userscript, no manifest involved.)

Affected Areas

Comments and JSDoc in src/ui/alert/, src/proxy/, src/messaging/ and the locales.ts build script,
plus two debug log strings in src/messaging/InterContextMessageHub.ts.

Backward Compatibility

  • Is this change backwards-compatible? Yes

Additional Notes

Two notes on your conventions, since I am an outside contributor:

  1. AGENTS.md requires commit messages to start with an AG-XXX ticket number. I do not have a tracker
    ticket, so I used the Conventional Commits fallback the same section allows (docs:). Happy to reword or
    rebase if you would rather attach a ticket number.
  2. I did not add a CHANGELOG.md entry, since nothing user-facing changed. Glad to add one if you prefer.

Not fixed here, but noticed on the same line as the ChildContextInjector change: Weakmap would more
conventionally be spelled WeakMap, matching the IWeakMap type on the next line. Left alone to keep this PR
to the verified set.

@AdamWr

AdamWr commented Sep 8, 2026

Copy link
Copy Markdown
Member

Thank you for opening a PR.

This public repository is a mirror of our private repository.
The changes from your PR have been incorporated into the private repository and are included in this commit - a87c834

Since the changes are now upstream, I will close this PR.
Thank you again for your contribution.

@AdamWr AdamWr closed this Sep 8, 2026
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.

2 participants