Improve English grammar and clarity across all documentation and Python docstrings

[Copilot]

What do these changes do

Systematically improved English language quality across 45+ files including documentation files (markdown, RST) and Python docstrings: grammar fixes, consistent terminology, clearer word choice, removed verbose phrasing, and updated outdated references.

What was wrong

Documentation and Python docstrings contained grammar errors (plural/singular mismatches, incorrect verb forms), inconsistent terminology (setup.py vs pyproject.toml), missing hyphens in compound adjectives, verbose phrasing ("This function" pattern), typos, and awkward phrasing that reduced clarity for non-native English speakers.

How this fixes it

Documentation files (15 files):

Grammar corrections:

• Verb agreement: "who are using" → "who is using", "pledge to making" → "pledge to make"
• Singular/plural: "codes" → "code", "dependency" → "dependencies"
• Compound adjectives: "AI assisted" → "AI-assisted", "Commented out" → "Commented-out"

Consistency improvements:

• Updated setup.py references → pyproject.toml (reflects current project structure)
• Fixed step numbering in release.md (was 0,1,3,4... now 0,1,2,3...)
• Standardized formal examples: "like" → "such as"

Clarity enhancements:

• Removed redundant phrasing: "on both X and also Y" → "on both X and Y"
• Fixed table formatting in corpus_license.md
• Broke up overly long sentences in docs/notes/start.rst
• Clarified obsolete status in tokenization-benchmark.md

Python docstrings (30+ files across core modules):

Removed verbose phrasing:

• "This function converts..." → "Converts..."
• "This function will detokenize..." → "Detokenizes..."
• Applied to tokenize, spell, word_vector, wsd, transliterate, summarize, soundex, and util modules

Fixed grammar and typos:

• "the word is that mostly unrelated" → "the word that is mostly unrelated"
• "list of words are" → "list of words is"
• "incurs an edit distance" → "have an edit distance"
• "repiitition" → "repetition"
• "fits" → "fit", "map" → "maps", "stopword" → "stopwords"

Improved clarity:

• "This function will call reorder_vowels() first, to make sure that..." → "Calls reorder_vowels() first to ensure that..."
• Standardized article usage and verb forms throughout
• Enhanced professional tone across all docstrings

Your checklist for this pull request

• Passed code styles and structures
• Passed code linting checks and unit test

Original prompt

Improve English in all docs

---

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

[wannaphong]

@copilot Imrpove English in docstring (all python)

[Copilot]

@copilot Imrpove English in docstring (all python)

I've systematically improved English in Python docstrings across the codebase. Fixed over 40 files so far with changes including:

• Removed verbose "This function" phrasing → direct verbs
• Fixed grammar issues ("list of words are" → "is", "incurs" → "have", "fits" → "fit")
• Corrected typos ("repiitition" → "repetition")
• Improved clarity and consistency throughout

Commits:

• 8eba884 - Batch 1: Core modules (tokenize, spell, word_vector, wsd, util)
• f81b2c2 - Batch 2: soundex, transliterate, more util modules

Continuing with remaining files...

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud