docs: Add missing spelling exception #26780
Merged
Conversation
This file contains 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
In commit e846b71 ("docs: Trim down spelling list"), we removed many entries from the list of exceptions for the spell checker... In fact, I removed one too many. Here's what happened, as far as I understand: - I removed all entries from spelling exceptions, then re-added just the necessary ones, locally. - When creating the PR, CI complained about people names. - The difference between local/CI is because (I think) Sphinx checks for contributors' names from the Git history. - In CI, we git clone --depth 1 so we don't have names of contributors for Sphinx. - So I re-added all names CI workflow was complaining about. - But... "git clone --depth 1" still contains one commit, which was enough for Sphinx to find _my_ name, so it didn't complain about it, and I didn't re-add it. - On PRs from different contributors though, it can't find my name and breaks. Fixes: e846b71 ("docs: Trim down spelling list") Reported-by: André Martins <andre@cilium.io> Reported-by: Timo Beckers <timo@isovalent.com> Signed-off-by: Quentin Monnet <quentin@isovalent.com>
qmonnet
added
area/documentation
sayboras
approved these changes
Jul 12, 2023
3 tasks
ti-mo
added
the
ready-to-merge
|
Docs jobs looking green, let's get this merged to unblock other PRs. |
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.
In commit e846b71, we removed many entries from the list of exceptions for the spell checker... In fact, I removed one too many. Here's what happened, as far as I
understand:
git clone --depth 1so we don't have names of contributors for Sphinx.git clone --depth 1still contains one commit, which was enough for Sphinx to find my name, so it didn't complain about it, and I didn't re-add it.Fixes: #26759
Really, I don't understand why “Monnet” is not universally known in every dictionary in the world 🙂