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

Fix typos Update README.md #204

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix typos Update README.md #204

wants to merge 1 commit into from

Conversation

mdqst
Copy link

@mdqst mdqst commented Nov 21, 2024

Description:
This pull request fixes two typos found in the documentation that could cause confusion or appear unprofessional to readers:

  1. "Python Instalation" heading

    • Error: Instalation
    • Correction: Installation
    • Importance: This is a prominent section header, and such errors may reduce the credibility of the documentation. Correct spelling ensures a polished and professional presentation.
  2. "Documenation" in the Table of Contents

    • Error: Documenation
    • Correction: Documentation
    • Importance: The Table of Contents is a crucial navigational aid. Typographical errors in it may confuse users and create inconsistency with the linked section headings. This fix ensures better user experience and clarity.

Both fixes contribute to maintaining the high-quality standard of the repository's documentation.

PR Checklist

  • Added Tests
  • Added Documentation
  • Breaking changes

Fix typos in "Python Installation" and "Documentation" headings
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.

1 participant