Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Clean up various documentation pages #12451

Merged
merged 8 commits into from
Jun 13, 2024

Conversation

neutraljump
Copy link
Contributor

Was looking through some of the documentation, and found some sentences/sections confusing to understand. As such this pull request edits/rewords select pages of the documentation for clarity, those currently being:

  • Contributing
  • Backwards compatibility
  • pytest import mechanisms and sys.path/PYTHONPATH

Feel free to look over our work and suggest any additions.

@nicoddemus
Copy link
Member

Thanks @neutraljump for the PR, left a minor comment regarding the spelling of pytest vs Pytest.

From a quick overview it looks like lowercase is more consistent, although some pages do use `pytest` in code blocks

Co-authored-by: Bruno Oliveira <[email protected]>
Copy link
Member

@nicoddemus nicoddemus left a comment

Choose a reason for hiding this comment

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

Thanks!

@nicoddemus nicoddemus merged commit 2effd8c into pytest-dev:main Jun 13, 2024
27 checks passed
@neutraljump neutraljump deleted the docs_cleanup branch June 14, 2024 02:46
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.

3 participants