Skip to content
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

Spellcheck API docs #818

Open
Tracked by #1892
Eric-Arellano opened this issue Feb 15, 2024 · 0 comments
Open
Tracked by #1892

Spellcheck API docs #818

Eric-Arellano opened this issue Feb 15, 2024 · 0 comments

Comments

@Eric-Arellano
Copy link
Collaborator

We currently ignore API docs:

documentation/cSpell.json

Lines 278 to 283 in be59189

"ignorePaths": [
// We cannot easily control these API docs since they live in other repositories.
"docs/api/qiskit/**/*.md*",
"docs/api/qiskit-ibm-runtime/**/*.md*",
"docs/api/qiskit-ibm-provider/**/*.md*"
]

While we can't easily control them*, they are still important parts of the documentation! We should aim to have no spelling issues. Some thoughts on how to approach this:

  • Should we add cspell to the source repositories? That's useful so that they detect the problems more quickly. It is annoying to add to their workflow and have to duplicate cSpell.json, though, to allow-list words.
  • We need an ignore mechanism for API docs. Ideally we can do that without changing cSpell.json; it doesn't work to add inline comments to the markdown. I'm wondering if we can instead ignore via our custom script.
  • When adding, we should keep the default npm run check:spelling to ignore API docs, per the spirit of API changes now check that API pages render #792.

*Note that we can make changes to historical API docs safely, if we're confident we won't add new versions of the API docs from CI. That is, if we're confident they're the final docs for that release series.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant