Repository navigation
Fix typos in documentation comments - #285
Merged
Merged
Conversation
Corrects 20 misspellings in YARD doc comments and one comment in .rubocop.yml. Documentation only - no code, API or behavior changes.
yeaseul-kim
force-pushed
the
fix-typos-in-doc-comments
branch
from
August 31, 2026 08:02
eb5fab4 to
c5dfc45
Compare
Collaborator
|
Thank a lot for the PR! 👏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Background
A spellcheck pass over
lib/turned up 19 misspellings in YARD documentationcomments, plus one in the opening comment of
.rubocop.yml. Several arerepeats of the same word (
truethyx4,formatedx2,outputedx2), so theyshow up in the generated docs in a few different places.
Change
lib/highline.rb:104outputedoutputtedlib/highline.rb:108indentatedindentedlib/highline.rb:134truethytruthylib/highline.rb:289beind used inbeing used inlib/highline/list.rb:126outputedoutputtedlib/highline/question.rb:372succesfulsuccessfullib/highline/question.rb:593truethytruthylib/highline/question.rb:596truethytruthylib/highline/question.rb:599truethytruthylib/highline/statement.rb:34formatedformattedlib/highline/statement.rb:37formatedformattedlib/highline/style.rb:29cretedcreatedlib/highline/style.rb:101convertionconversionlib/highline/template_renderer.rb:56contantsconstantslib/highline/terminal.rb:17decenddescendlib/highline/terminal.rb:64YiedsYieldslib/highline/terminal.rb:80accordlingaccordinglylib/highline/terminal.rb:143@!group Enviroment queries@!group Environment querieslib/highline/terminal.rb:162debuggindebugging.rubocop.yml:1Bellow the changesBelow the changesoutputedis corrected tooutputtedrather than to the uninflectedoutput. Both are valid past participles, butoutputtedkeeps the edit tothe misspelling itself instead of also changing the style, and it avoids the
brief noun/verb ambiguity in "suitable to be directly output to the screen".
Happy to use
outputinstead if you prefer that form.Scope
Comments only. No code, API or behaviour changes, so no tests are added.
Two things were deliberately left alone:
Changelog.mdhas a handful of typos too (enviroment,begining,dependancy,implemetation,overides), but those are historical releasenotes, so editing them retroactively felt wrong.
stringfy/stringfied/stringfies/stringfyingare not typos incontext —
stringfyis a real method (lib/highline/list.rb:173,lib/highline/statement.rb:54) and the comments correctly refer to it.Renaming the method would be a breaking change, so both were left as is.