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.

Sign up for GitHub

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

Jump to bottom

docs: Update docstrings and readme #39

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Update docstrings and readme #39

wants to merge 2 commits into from

Commits on May 29, 2024

  1. docs: Update test docstrings 

    Patch docstrings with the following:
- Fix grammar and typo errors.
- Annotate `TODO` for consistency throughout project.

[Note]
TODOs in project adhere to the following style: `@TODO:`
    @apexDev37
    apexDev37 committed May 29, 2024
    Configuration menu
    Copy the full SHA
    5c3b93c View commit details
    Browse the repository at this point in the history

  2. docs: Fix typos 

    Patch `README` files by fixing typos to improve user experience.

[Note]
Py package `codespell` was used to find and fix typos in the repo.

[Commands]
➜ codespell .
➜ codespell -i 3 -w

[Docs]
See: https://github.com/codespell-project/codespell
    @apexDev37
    apexDev37 committed May 29, 2024
    Configuration menu
    Copy the full SHA
    ee489f3 View commit details
    Browse the repository at this point in the history