router: hide low-level route helpers from rustdoc#162
Open
Yong-yuan-X wants to merge 1 commit into
Open
Conversation
|
All contributors have signed the CLA ✍️ ✅ |
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.
Summary
Router::route_*helpers from rustdoc while keeping them public for generated code<Service>Ext::registerAPIRouter::with_specbehavior without hiding the typed APIThis focuses on the small scope described in #91: hiding the low-level stringly-typed route helpers from rustdoc and updating the docs to point users toward generated service registration.
Runtime behavior and API compatibility are unchanged.
Fixes #91
Testing
cargo fmt -p connectrpc -- --checkcargo clippy -p connectrpc --all-features --lib -- -D warningscargo test -p connectrpc --libcargo doc -p connectrpc --all-features --no-depscargo check -p multiservice-example --all-featurescargo check -p eliza-example --all-features