-
-
Notifications
You must be signed in to change notification settings - Fork 278
Fix docstring style in parser module #1111
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
Open
Himanshu-Vishwakarma-GH
wants to merge
4
commits into
collective:main
Choose a base branch
from
Himanshu-Vishwakarma-GH:fix-docstring-style
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+47
−2
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| # Configure Vale to Check Python Docstrings for Spelling and Style | ||
|
|
||
| This PR configures Vale to run on Python docstrings, ensuring consistent style and spelling in the documentation. The changes exclude test code and comments as per the issue requirements. | ||
|
|
||
| ## Changes Made | ||
|
|
||
| ### 1. Updated `.vale.ini` | ||
| - Added a `[*.py]` section to configure Vale for Python files. | ||
| - Set `BasedOnStyles = Vale, Microsoft` for Python files. | ||
| - Added `TokenIgnores` to ignore Python comments (starting with `#`) and Sphinx roles (e.g., `:class:`). | ||
| - This ensures Vale checks docstrings but skips code comments and test files. | ||
|
|
||
| ### 2. Updated `Makefile` | ||
| - Modified `VALEFILES` to include Python source files from `src/icalendar/` while excluding `*/tests/*` and `*/fuzzing/*` directories. | ||
| - This targets only the main source code for docstring checking, avoiding test code and comments. | ||
|
|
||
| ### 3. Synced Vale Styles | ||
| - Ran `uv run vale sync` to ensure all Vale styles and packages are up to date. | ||
|
|
||
| ## Next Steps | ||
| - Run `make vale` to check for spelling and style issues in Python docstrings. | ||
| - Fix any identified issues by correcting spelling mistakes or adjusting word lists in `docs/styles/config/vocabularies/`. | ||
| - Potentially extend the accept and reject lists in `Base/accept.txt`, `Base/reject.txt`, and `icalendar/accept.txt`, `icalendar/reject.txt` based on findings. | ||
|
|
||
| ## Testing | ||
| - The configuration has been set up to run Vale on Python files without affecting test code or comments. | ||
| - Vale sync has been completed successfully. | ||
|
|
||
| Closes #1007 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Before merging this PR, this file should be removed. It's good to keep it for now, while we troubleshoot the PR and try to understand what's not passing.