-
Notifications
You must be signed in to change notification settings - Fork 14.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix false-positive spellcheck failure #29190
Conversation
@@ -24,7 +24,7 @@ def format_tags(source: Any, *, key_label: str = "Key", value_label: str = "Valu | |||
If given a dictionary, formats it as an array of objects with a key and a value field to be passed to boto | |||
calls that expect this format. | |||
Else, assumes that it's already in the right format and returns it as is. We do not validate | |||
the format here since it's done by boto anyway, and the error wouldn't be clearer if thrown from here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"wouldn't" seems perfectly reasonable here and is spelled correctly, so this is strange. However, "would not" works just as well, and if it makes the tests more stable then I guess why not 🤷
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I tried add into docs/spelling_wordlist.txt
different combination: wouldn
, wouldn'
, wouldn't
but without any luck 😒
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That wouldn't (ehm!) work ... :D. I think the spelling wordlist acts on "words" only and ' is not considered as a letter.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, that is the reason why I replace as most easier option.
Need to try to found again why this kind of errors not detected in CI, for example this one also wasn't detected in CI, #28587
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's (ehm! 😆 ) also curious that it accepts the concatenated word it's
in the same sentence but it doesn't like wouldn't
🤔
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When i tried to found the nature of this spellcheck errors I found this comment funny: sphinx-contrib/spelling#126 (comment)
Annoying error in local AWS Documentation build
Funnily enough there is no any error if I run
Still don't know is it only me or related to sphinx-contrib/spelling#126
Seems like there this not affect CI however it isn't first time when CI Build Docs not reported all spelling errors.