Repository navigation
docs: fix docstring for T_SYNTAX_PARSER_TERM - #70
Merged
Merged
Conversation
Signed-off-by: Jan Kowalleck <jan.kowalleck@gmail.com>
Documentation build overview
|
There was a problem hiding this comment.
Pull request overview
Updates documentation to accurately describe the accepted top-level RFC 3987 parser start terms by correcting the T_SYNTAX_PARSER_TERM docstring and recording the change in the changelog.
Changes:
- Fix
T_SYNTAX_PARSER_TERMdocstring to referenceis_valid_syntax(instead ofcheck). - Add an Unreleased changelog entry for the docstring correction (with PR reference link).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/rfc3987_syntax2/syntax_helpers.py | Corrects the T_SYNTAX_PARSER_TERM docstring to match the actual public API (parse + is_valid_syntax). |
| CHANGELOG.md | Adds an Unreleased “Docs” entry documenting the docstring fix and links to PR #70. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
No description provided.