Skip to content

Conversation

@a5chin
Copy link
Owner

@a5chin a5chin commented Nov 26, 2025

PR Type

Enhancement, Bug fix, Documentation


Description

  • Integrate Code Spell Checker extension.

  • Configure spell checker with custom dictionary.

  • Correct numerous typos in code and documentation.

  • Update pytest output examples in guides.


Diagram Walkthrough

flowchart LR
  A[Add Code Spell Checker Extension] --> B[Configure Spell Checker]
  A --> C[Update VS Code Recommended Extensions]
  D[Review & Fix Typos] --> E[Update Documentation]
  D --> F[Update Code Comments]
Loading

File Walkthrough

Relevant files
Bug fix
7 files
timer.py
Corrected typo in `__exit__` method docstring.                     
+1/-1     
pull_request_template.md
Corrected 'docstrings' to 'docstring' in PR template checklist.
+1/-1     
test.yml
Corrected 'Coverage Bagdge' to 'Coverage Badge' action name.
+1/-1     
CONTRIBUTING.md
Standardized 'Docstrings' to 'Docstring' in contribution guide.
+3/-3     
index.md
Corrected 'module docstrings' to 'module docstring' ignore rule
explanation.
+1/-1     
uv.md
Corrected 'uv Configations' to 'uv Configurations' documentation
title.
+1/-1     
config.md
Corrected 'docstrings' to 'docstring' and updated DATABASE_URL
example.
+2/-2     
Enhancement
3 files
devcontainer.json
Added Code Spell Checker extension to dev container configuration.
+1/-0     
cspell.json
Introduced Code Spell Checker configuration with custom word list.
+114/-0 
extensions.json
Added Code Spell Checker to recommended VS Code extensions.
+1/-0     
Documentation
1 files
test.md
Updated `pytest` output example to reflect current test environment.
+17/-15 

@a5chin a5chin self-assigned this Nov 26, 2025
@github-actions github-actions bot added documentation Improvements or additions to documentation feature labels Nov 26, 2025
@github-actions
Copy link
Contributor

Coverage

Coverage Report
FileStmtsMissCover
tools/config
   fastapi.py20100%
   settings.py200100%
tools/logger
   color.py120100%
   googlecloud.py60100%
   local.py120100%
   logger.py230100%
   style.py70100%
   type.py50100%
tools/tracer
   timer.py160100%
TOTAL1030100%

Tests Skipped Failures Errors Time
8 0 💤 0 ❌ 0 🔥 1.451s ⏱️

@a5chin
Copy link
Owner Author

a5chin commented Nov 26, 2025

/review

@github-actions
Copy link
Contributor

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Custom Dictionary

Review the custom dictionary in cspell.json to ensure all added words are indeed intended to be ignored by the spell checker and do not represent actual typos. The current list appears to contain technical terms and project-specific names, which is appropriate.

"words": [
    "addopts",
    "anyio",
    "apdisk",
    "autoflake",
    "buildkit",
    "buildx",
    "caplog",
    "celerybeat",
    "charliermarsh",
    "classmethod",
    "commitable",
    "configfile",
    "connor",
    "contextlib",
    "cookiecutter",
    "cooldown",
    "coveragerc",
    "cython",
    "dhoeric",
    "direnv",
    "dmypy",
    "dockerfiles",
    "donotpresent",
    "exiasr",
    "fastapi",
    "fontawesome",
    "fseventsd",
    "googlecloud",
    "htmlcov",
    "imread",
    "ipykernel",
    "ipynb",
    "ipython",
    "isort",
    "junitxml",
    "kevinrose",
    "kwargs",
    "levelname",
    "levelno",
    "libgl",
    "libglib",
    "linenums",
    "mishakav",
    "mkdocs",
    "monkeypatch",
    "mosapride",
    "mypy",
    "njpwerner",
    "norecursedirs",
    "nosetests",
    "noxfile",
    "nullcontext",
    "opencontainers",
    "opencv",
    "pipefail",
    "pipenv",
    "pipfile",
    "pluggy",
    "posargs",
    "pybuilder",
    "pycache",
    "pycodestyle",
    "pydantic",
    "pydocstyle",
    "pyenv",
    "pyflakes",
    "pyflow",
    "pymdownx",
    "pypa",
    "pypackages",
    "pyproject",
    "pyrightconfig",
    "pytest",
    "pythondontwritebytecode",
    "pythonpath",
    "pythonunbuffered",
    "pytype",
    "pyupgrade",
    "qodo",
    "redoc",
    "rootdir",
    "ropeproject",
    "scrapy",
    "sdist",
    "sessionmaker",
    "shardulm",
    "spyder",
    "spyderproject",
    "spyproject",
    "sqlalchemy",
    "stmts",
    "superfences",
    "tamasfe",
    "testpaths",
    "timemachine",
    "toolsai",
    "typer",
    "uline",
    "usecases",
    "usefixtures",
    "usermod",
    "venv",
    "webassets",
    "yzhang",
    "zenkaku"
]

@a5chin
Copy link
Owner Author

a5chin commented Nov 26, 2025

/improve

@github-actions
Copy link
Contributor

github-actions bot commented Nov 26, 2025

PR Code Suggestions ✨

No code suggestions found for the PR.

@a5chin a5chin merged commit cf44897 into main Nov 27, 2025
9 checks passed
@a5chin a5chin deleted the feature/spell-checker branch November 27, 2025 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation feature Review effort 2/5

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants