Skip to content

add typos#505

Open
chirizxc wants to merge 1 commit intoTishka17:developfrom
chirizxc:typos
Open

add typos#505
chirizxc wants to merge 1 commit intoTishka17:developfrom
chirizxc:typos

Conversation

@chirizxc
Copy link
Copy Markdown
Contributor

@chirizxc chirizxc commented Dec 13, 2025

Summary by CodeRabbit

Release Notes

  • Bug Fixes

    • Corrected parameter naming in scroll component API.
  • Documentation

    • Fixed spelling errors across documentation files.
  • Chores

    • Enhanced CI pipeline with additional code quality checks.
    • Updated development dependencies.

✏️ Tip: You can customize this high-level summary in your review settings.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Dec 13, 2025

Walkthrough

This PR introduces a typos linting tool to the CI workflow via a new GitHub Actions step, fixes multiple typos across documentation and code files, renames a misspelled function parameter, and updates development dependencies.

Changes

Cohort / File(s) Summary
CI/Linter Configuration
.github/workflows/setup.yml, .typos.toml
Added "Run typos" step to the cpython job workflow and created typos linter configuration with [default.extend-words] mapping for "nam".
Documentation Typo Fixes
docs/migration.rst, docs/widgets/passing_data/index.rst, docs/widgets/text/case/example.py, docs/widgets/text/case/index.rst
Corrected spelling errors: "whe dialog start" → "when dialog start", "acess" → "access", and "wich" → "which" in multiple locations.
Dependency Updates
requirements_dev.txt
Updated ruff from 0.14.8 to 0.14.9 and added new dev dependency typos==1.40.0.
Source Code Parameter Rename
src/aiogram_dialog/widgets/common/scroll.py
Renamed function parameter from on_page_chaged to on_page_changed in sync_scroll() function signature and internal usage.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

  • CI workflow verification: Confirm "Run typos" step executes correctly in the workflow pipeline.
  • Parameter rename impact: Verify that the on_page_changed parameter rename in sync_scroll() is backward compatible or if it's a public API change requiring deprecation handling.
  • Linter configuration: Ensure the typos configuration with the "nam" extension rule aligns with project naming conventions.

Poem

🐰 A typo hunt through code and docs so grand,
With ruff and typos keeping watch so planned,
Misspelled "acess" now flows with grace,
And "chaged" to "changed" finds its rightful place!
From workflow steps to scrolling smooth and true,
This rabbit cheers the fixes through and through! ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. You can run @coderabbitai generate docstrings to improve docstring coverage.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding the typos linter tool to the CI pipeline and project configuration.
✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8ab9b68 and 673e479.

⛔ Files ignored due to path filters (8)
  • examples/mega/media/1.png is excluded by !**/*.png
  • examples/mega/media/2.png is excluded by !**/*.png
  • examples/mega/media/3.png is excluded by !**/*.png
  • examples/mega/media/4.png is excluded by !**/*.png
  • examples/mega/media/5.png is excluded by !**/*.png
  • examples/mega/media/6.png is excluded by !**/*.png
  • examples/mega/media/7.png is excluded by !**/*.png
  • examples/python_logo.png is excluded by !**/*.png
📒 Files selected for processing (8)
  • .github/workflows/setup.yml (1 hunks)
  • .typos.toml (1 hunks)
  • docs/migration.rst (1 hunks)
  • docs/widgets/passing_data/index.rst (1 hunks)
  • docs/widgets/text/case/example.py (3 hunks)
  • docs/widgets/text/case/index.rst (1 hunks)
  • requirements_dev.txt (1 hunks)
  • src/aiogram_dialog/widgets/common/scroll.py (1 hunks)
🔇 Additional comments (10)
docs/widgets/text/case/index.rst (1)

11-11: LGTM! Documentation typo corrected.

The typo fix from "wich" to "which" improves the documentation clarity.

docs/migration.rst (1)

64-64: LGTM! Documentation typo corrected.

The typo fix from "whe" to "when" improves the documentation clarity.

.github/workflows/setup.yml (1)

50-52: LGTM! Typos linting step added appropriately.

The new "Run typos" step is well-positioned after linting and before tests, ensuring typo checks are performed early in the CI pipeline.

.typos.toml (1)

1-3: LGTM! Typos configuration prevents false positives.

The configuration correctly extends the dictionary to recognize "nam" as a valid Latin word, preventing false positives in documentation or code that may contain Lorem Ipsum or similar Latin text.

docs/widgets/text/case/example.py (3)

20-20: LGTM! Comment typos corrected.

The typo fixes from "wich" to "which" in the code comments improve documentation clarity.


35-35: LGTM! Comment typo corrected.


52-52: LGTM! Comment typo corrected.

docs/widgets/passing_data/index.rst (1)

31-31: LGTM! Documentation typo corrected.

The typo fix from "acess" to "access" improves the documentation clarity.

src/aiogram_dialog/widgets/common/scroll.py (1)

82-100: Parameter rename is safe—no breaking changes detected.

Verification confirms that the old parameter name on_page_chaged is not used anywhere in the codebase, and the sole sync_scroll call uses the corrected parameter name. The rename from the typo to on_page_changed introduces no breaking changes.

requirements_dev.txt (1)

3-4: Both package versions are valid and secure.

ruff 0.14.9 (released Dec 11, 2025) and typos 1.40.0 (released Nov 26, 2025) are available on PyPI with no known security advisories. A prior parser vulnerability in ruff was fixed in version 0.14.2, well before the current 0.14.9 release.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@chirizxc
Copy link
Copy Markdown
Contributor Author

cc @Tishka17

@Tishka17
Copy link
Copy Markdown
Owner

Renaming example->examples will break links shared in the internet. I do not see it useful


def sync_scroll(
scroll_id: str | Sequence[str],
on_page_chaged: OnPageChanged | None = None,
Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

compatibility issue

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.

2 participants