canonical / canonical/documentation-style-guide
Ignore rules do not cover text after RST `raw` directives or labels in `ref` or `doc` roles
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 22
- Forks
- 41
- PR merge metrics
- No merged PRs in 30d
Description
Describe the bug
Labels in RST ref or doc roles are checked for spelling, as is text following raw directives. This results in a failed spellcheck on files with, for example, .. raw:: html (html is flagged) or a "misspelled" label.
To Reproduce
Text sample:
.. raw:: html
<p>Raw text</p>
See our :ref:`howtos`.
Expected behavior
I expect the spellcheck to ignore html in the raw directive, and the howtos in the ref role (since it would be replaced by the heading text on which the howtos label is applied).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Reproduce the issue with the supplied RST sample and trace the spellcheck rules that process raw directives and ref/doc roles. Done means html after a raw directive and howtos used as a role label are ignored, while ordinary prose and heading text remain spellchecked.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 64/100