Skip to content

Conversation

@IlmaxRehman
Copy link

Summary

This PR fixes several documentation issues including typos, HTML markup errors, and outdated links across the Typer repository.

Changes

Typo Fixes

  • README.md and docs/index.md: Changed "the final users" to "end users" for better clarity
  • docs/management-tasks.md: Changed "final users" to "end users" and improved sentence structure

HTML Fixes

  • README.md and docs/index.md: Added missing closing </a> tag for the coverage badge link to fix HTML structure

Link Updates

  • typer/_typing.py: Updated PEP 586 link from outdated www.python.org/dev/peps/pep-0586 to current format peps.python.org/pep-0586/
  • README.md, docs/index.md, and typer-cli/README.md: Updated GitHub Actions badge URLs from /workflows/ to /actions/workflows/ format for modern GitHub badge URLs

Files Changed

  • typer/README.md
  • typer/docs/index.md
  • typer/docs/management-tasks.md
  • typer/typer/_typing.py
  • typer/typer-cli/README.md

Testing

  • All changes are documentation-only
  • No linting errors introduced
  • Links verified to use current URL formats

Impact

  • Improves documentation clarity
  • Fixes HTML markup issues
  • Ensures all external links use current, working URLs
  • No breaking changes

@github-actions github-actions bot added the docs Improvements or additions to documentation label Dec 11, 2025
@github-actions
Copy link
Contributor

@github-actions github-actions bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 19, 2025
@github-actions
Copy link
Contributor

This pull request has a merge conflict that needs to be resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

conflicts Automatically generated when a PR has a merge conflict docs Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant