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 errors #13031

Open
1 task done
JoshuaPerdue opened this issue Oct 18, 2024 · 0 comments
Open
1 task done

Documentation errors #13031

JoshuaPerdue opened this issue Oct 18, 2024 · 0 comments
Labels
type: docs Documentation related

Comments

@JoshuaPerdue
Copy link

Description

Multiple files have incorrect spellings of words in documentation in both content and code segments

The following files have issues:
docs/html/development/architecture/command-line-interface.rst
docs/html/development/architecture/overview.rst
docs/html/ux-research-design/research-results/improving-pips-documentation.md
docs/html/ux-research-design/research-results/personas.md
docs/html/ux-research-design/research-results/pip-force-reinstall.md
docs/html/ux-research-design/research-results/prioritizing-features.md
docs/html/ux-research-design/research-results/users-and-security.md
src/pip/_internal/configuration.py
src/pip/_internal/metadata/init.py
src/pip/_internal/metadata/importlib/_dists.py
src/pip/_internal/pyproject.py

Expected behavior

Documentation is expected to be correct and accurate with regards to how the code is described, intended to function, and how it is implemented.

pip version

any

Python version

any

OS

any

How to Reproduce

  1. Get source
  2. Inspect documentation
  3. See typos

Output

No response

Code of Conduct

@JoshuaPerdue JoshuaPerdue added S: needs triage Issues/PRs that need to be triaged type: bug A confirmed bug or unintended behavior labels Oct 18, 2024
@notatallshaw notatallshaw added type: docs Documentation related and removed type: bug A confirmed bug or unintended behavior S: needs triage Issues/PRs that need to be triaged labels Oct 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Documentation related
Projects
None yet
Development

No branches or pull requests

2 participants