Skip to content

docs: fix docstring for T_SYNTAX_PARSER_TERM #70

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

Merged
jkowalleck merged 2 commits into from
Jul 24, 2026
Merged

docs: fix docstring for T_SYNTAX_PARSER_TERM #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7a5c450
docs: fix docstring for T_SYNTAX_PARSER_TERM
jkowalleck Jul 24, 2026
5dc9277
docs
jkowalleck Jul 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.

<!-- unreleased things below this line -->

* Docs
* Fixed docstring of `T_SYNTAX_PARSER_TERM` (via [#70])

[#70]: https://github.com/jkowalleck/rfc3987-syntax2/pull/70

## v1.3.1 - 2026-07-23

* Docs
Expand Down
3 changes: 2 additions & 1 deletion src/rfc3987_syntax2/syntax_helpers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@
"""

T_SYNTAX_PARSER_TERM = Literal["iri", "iri_reference", "absolute_iri"]
"""Top-level RFC 3987 parser start terms accepted by :func:`parse` and :func:`check`.
"""Top-level RFC 3987 parser start terms accepted by :func:`parse` and :func:`is_valid_syntax`.

Allowed values are ``"iri"``, ``"iri_reference"``, and ``"absolute_iri"``.
"""

_SYNTAX_PARSER_STARTS: list[T_SYNTAX_PARSER_TERM] = ["iri", "iri_reference", "absolute_iri"]


Expand Down