docs(templated_uri): fix BaseUri docs to reflect path prefix support#327
Merged
kate-shine merged 3 commits intomainfrom Mar 19, 2026
Merged
Conversation
BaseUri contains an optional path prefix (BasePath), but documentation incorrectly stated it only stores scheme and authority with no path. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates BaseUri documentation to correctly describe support for an optional path prefix (BasePath), aligning crate docs and README with the actual type behavior.
Changes:
- Clarified
BaseUridocs to include optional path prefix support (not just scheme/authority). - Updated crate-level docs and README bullets for consistent
BaseUridescription. - Adjusted
BaseUriDisplaydocs to mention path output.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| crates/templated_uri/src/lib.rs | Updates crate-level BaseUri bullet to include optional path prefix. |
| crates/templated_uri/src/base_uri.rs | Clarifies BaseUri rustdoc and updates Display formatting description. |
| crates/templated_uri/README.md | Aligns README BaseUri description with path prefix support (and regenerates cargo-doc2readme metadata). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #327 +/- ##
=======================================
Coverage 100.0% 100.0%
=======================================
Files 168 168
Lines 11903 11903
=======================================
Hits 11903 11903 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
…s and lib.rs Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
martintmk
approved these changes
Mar 19, 2026
Vaiz
approved these changes
Mar 19, 2026
Vaiz
added a commit
that referenced
this pull request
Apr 10, 2026
- ✨ Features - Support redaction suppression. ([#332](#332)) - 🐛 Bug Fixes - restore const on UriSafeString::from_static ([#328](#328)) - 📚 Documentation - fix BaseUri docs to reflect path prefix support ([#327](#327)) - ♻️ Code Refactoring - use re-exported macros instead of importing templated_uri_macros directly ([#324](#324))
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.
BaseUri contains an optional path prefix (BasePath), but documentation incorrectly stated it only stores scheme and authority with no path.