Repository navigation
docs: update readme after PR#10 - #20
Merged
Merged
Conversation
jkowalleck
force-pushed
the
docs/readme-update-PR10
branch
from
July 16, 2026 11:46
143c914 to
009cf68
Compare
There was a problem hiding this comment.
Pull request overview
Updates README.md to reflect the grammar/source mapping and examples after PR #10’s RFC 3987 alignment work, improving the accuracy of the project’s public documentation.
Changes:
- Reformats the “Limitations” section to clearly enumerate what is not validated (removing misleading checkmark bullets).
- Fixes the
is_valid_syntax(term='iri_reference', value='bob')usage example so it correctly demonstrates a valid IRI-reference. - Updates the rule-to-source mapping table to attribute IRI-specific productions (e.g.,
iauthority,ipath_*) to RFC 3987 and adds helper/component entries (non_zero,unreserved).
💡 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.
updte docs to reflect changes of #10