Skip to content

docs: fix 9 typos in code comments and an error message - #247

Open
Avicennasis wants to merge 1 commit into
WeTransfer:masterfrom
TypoScan3000:docs/fix-typos
Open

Avicennasis wants to merge 1 commit into
WeTransfer:masterfrom
TypoScan3000:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fix typos in comments across seven files, plus one error message:

  • lib/parsers/json_parser/validator.rb: "much larger then necessary" → "than"; error message "Literal to large at ..." → "Literal too large at ..."
  • lib/parsers/exif_parser.rb: "contans" → "contains"
  • lib/care.rb: "juse use the only page" → "just use"
  • lib/parsers/webp_parser.rb: the header table said VB8 where it means VP8 ("VB8 ", "VB8X", "The VB8 variant", "the VB8 data"). It now matches the 'VP8' / 'VP8L' / 'VP8X' values read_data switches on.
  • lib/remote_io.rb: "at lease not" → "at least not"
  • lib/parsers/jpeg_parser.rb: "it's bits and bobs" → "its"
  • lib/parsers/mpeg_parser.rb: "looping though the stream" → "through"

The only non-comment change is the JSONParserError message text. JSONParser rescues that error, and no spec asserts on the message.

Deliberately left alone: the Measurometer counter format_parser.parser.care.page_reads_from_upsteam in lib/care.rb is misspelled, but renaming an emitted metric would break any dashboard or alert keyed on it. That is your call.

No functional changes — comments plus one error-message string.

Comment typos across the parsers (then/than, contans, juse, lease, though,
it's/its, VB8 -> VP8 in the WebP header table, matching the 'VP8 '/'VP8L'/'VP8X'
values the code switches on), plus 'Literal to large' -> 'Literal too large'
in a JSONParserError message that JSONParser rescues internally.

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