Skip to content

docs: fix typo and grammar issues in quality guide#2286

Merged
srittau merged 4 commits into
python:mainfrom
BHUVANSH855:docs/fix-testing-guide-typos
May 18, 2026
Merged

docs: fix typo and grammar issues in quality guide#2286
srittau merged 4 commits into
python:mainfrom
BHUVANSH855:docs/fix-testing-guide-typos

Conversation

@BHUVANSH855
Copy link
Copy Markdown
Contributor

Summary

This PR fixes a few minor typo and grammar issues in docs/reference/quality.rst.

Changes made

  • Fixed duplicated word:

    • options optionsoptions
  • Improved grammar/style:

    • command line flagcommand-line flag
    • Added proper reStructuredText formatting for pyright

These are documentation-only changes with no behavioral impact.

@BHUVANSH855
Copy link
Copy Markdown
Contributor Author

hi @JelleZijlstra,

Kindly have a look on this.

Comment thread docs/reference/quality.rst Outdated
-----------------------------

pyright has a special command line flag, ``--verifytypes``, for verifying
``pyright`` has a special command-line flag, ``--verifytypes``, for verifying
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't use "pyright" as a command name here, but as a proper noun. So it shouldn't be in backticks, but it should be capitalized. Same with "mypy" below.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I’ve updated

@BHUVANSH855 BHUVANSH855 requested a review from srittau May 18, 2026 16:43
Copy link
Copy Markdown
Collaborator

@srittau srittau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@srittau srittau merged commit 187c90b into python:main May 18, 2026
5 checks passed
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.

2 participants