You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
// 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.
*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.
The text was updated successfully, but these errors were encountered:
We currently ignore API docs:
documentation/cSpell.json
Lines 278 to 283 in be59189
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:
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.
The text was updated successfully, but these errors were encountered: