Qiskit / Qiskit/documentation

Audit dictionaries - cspell

Open
#3,345 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

content 📄
Dominant language
Jupyter Notebook
Stars
106
Forks
223
Avg merge
1d 8h
Merged PRs (30d)
72

Description

  • Verify that all words are in the proper dictionary file
  • Verify that the words in the dictionaries are not actual typos
  • Check for words that should only be ignored in a file rather than globally

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the cspell dictionary files used by this documentation repository and reviewing their current entries. Check each word against the three audit criteria in the issue; done means entries are in the appropriate dictionary, apparent typos are removed or corrected, and file-specific exceptions are not kept globally.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.