Skip to content

fix: grammar, spelling, and clarity issues across the codebase#1775

Merged
nathanjmcdougall merged 8 commits intomainfrom
copilot/run-usethis-qa-llm-review-agent-skill
Apr 3, 2026
Merged

fix: grammar, spelling, and clarity issues across the codebase#1775
nathanjmcdougall merged 8 commits intomainfrom
copilot/run-usethis-qa-llm-review-agent-skill

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Apr 3, 2026

  • Run usethis-qa-grammar skill across the whole codebase
    • Review documentation files (README, docs/, CONTRIBUTING.md, etc.) — 15 fixes
    • Review agent skill files (.agents/skills/) — 5 fixes
    • Review CLI help text and user-facing messages — 3 fixes
    • Review docstrings and code comments — 24 fixes
    • Review error messages — 4 fixes
    • Review test files — 5 fixes
  • Fix identified issues (56 total across 43 files)
  • Run usethis-qa-static-checks after fixes — all 29 prek hooks pass, basedpyright clean
  • Address review feedback: restore British spelling "behaviour", update grammar skill
  • Record lessons — Write a test that all typer options objects have different help text #1779

Skills used: usethis-qa-llm-review, usethis-qa-grammar, usethis-qa-static-checks, usethis-github-issue-create, usethis-skills-modify

Resolves #1770

Copilot AI and others added 6 commits April 3, 2026 19:38
- Fix 'a internal' → 'an internal' (pipeweld.md)
- Remove duplicated word 'like like' (pipeweld.md)
- Fix 'more a more' → 'a more' (pipeweld.md)
- Fix 'must be execute' → 'must be executed' (pipeweld.md)
- Remove stray 'they' in 'if they the two groups' (pipeweld.md)
- Fix 'is you use' → 'if you use' (frameworks.md)
- Fix 'necessary sensible' → 'necessarily sensible' (philosophy.md)
- Fix 'applied your codebase' → 'applied to your codebase' (detailed-example.md)
- Fix 'a part of a templates' → 'part of templates' (README, similar-projects.md)
- Remove extra space before comma in acknowledgements (README)
- Fix 'people with Astral' → 'people at Astral' (README)
- Fix 'sonar-projects.properties' → 'sonar-project.properties' (README, overview.md)
- Fix 'through until' → 'until' (CONTRIBUTING.md)
- Fix 'pulled out the' → 'pulled out of the' (CHANGELOG.md)
- Fix 'not Git Repository' → 'no Git repository' (CHANGELOG.md)

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
- usethis-github-actions-update: fix broken grammar 'For in this example' → 'In this example'
- usethis-python-code-modify: fix typo 'unusually' → 'usually'
- usethis-python-module-layout-modify: fix missing closing quote in version, fix backslash path separators
- usethis-qa-static-checks: fix misspelling 'mkdownlint-cli2' → 'markdownlint-cli2'

Bump version numbers on all modified skills per usethis-skills-modify guidelines.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
- Fix copy-paste bug in status_arg: help text said 'Docstring style to
  enforce.' instead of 'Development status to set.'
- Fix typo in show sonarqube help: 'sonar-projects.properties' ->
  'sonar-project.properties' (singular)
- Add missing period to 'Show the name of the project' help text for
  consistency with peer commands

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
Fix 24 issues across 17 source files including typos, wrong articles,
missing prepositions, duplicate words, wrong file references, misplaced
docstrings, and grammatical errors.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
- Add missing verb 'is' in 'Hook ... is not recognized' (hooks.py)
- Quote module name and fix comma splice in imports.py error message
- Quote package name in warning messages for consistency (tach.py, import_linter.py)
- Update corresponding test assertions

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Co-authored-by: nathanjmcdougall <18602289+nathanjmcdougall@users.noreply.github.com>
- conftest.py: Fix typo 'offline model' → 'offline mode'
- test_core_tool.py: Fix subject-verb agreement 'placeholders gets' → 'placeholders get'
- test_yaml_io_.py: Add missing period to docstring for consistency
- test_yaml_io_.py: Fix test assertion 'indentation the' → 'indentation in the' (was causing test failure)
- test_func.py: Add missing period to docstring for consistency

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Copilot AI changed the title [WIP] Run the usethis-qa-llm-review agent skill across the codebase fix: grammar, spelling, and clarity issues across the codebase Apr 3, 2026
Copilot AI requested a review from nathanjmcdougall April 3, 2026 20:15
Comment thread src/usethis/_core/tool.py Outdated
@nathanjmcdougall nathanjmcdougall marked this pull request as ready for review April 3, 2026 20:24
@codspeed-hq
Copy link
Copy Markdown

codspeed-hq Bot commented Apr 3, 2026

Merging this PR will not alter performance

✅ 2 untouched benchmarks


Comparing copilot/run-usethis-qa-llm-review-agent-skill (bc6bf76) with main (f84d89d)1

Open in CodSpeed

Footnotes

  1. No successful run was found on main (d6f8ba7) during the generation of this report, so f84d89d was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 3, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

📢 Thoughts on this report? Let us know!

@nathanjmcdougall nathanjmcdougall merged commit 77daebb into main Apr 3, 2026
20 checks passed
@nathanjmcdougall nathanjmcdougall deleted the copilot/run-usethis-qa-llm-review-agent-skill branch April 3, 2026 21:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Run the usethis-qa-llm-review agent skill for the first time

2 participants