doc: ignore anchor titles in spellcheck - #848
Merged
Merged
Conversation
Signed-off-by: Minae Lee <minae.lee@canonical.com>
Contributor
|
I guess we can now also remove https://github.com/canonical/microcloud/blob/main/doc/.custom_wordlist.txt#L69 again from the custom wordlist? |
Author
Yep! |
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
2 participants
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.
Anchor titles for intersphinx links (in the form of
<a ... title="in MicroCeph vv19.2.0-squid">, for example) are affected by what other documentation sets put as theVersionin theirobjects.invmetadata. This can cause spellcheck to fail, as seen here.This PR prevents anchor titles from being checked in spellcheck, so that we don't have to spellcheck what intersphinx pulls into that title. Anchor titles are rarely used and this should have little to no impact otherwise.