Skip to content

router: hide low-level route helpers from rustdoc#162

Open
Yong-yuan-X wants to merge 1 commit into
anthropics:mainfrom
Yong-yuan-X:fix/91-hide-manual-router-routes
Open

router: hide low-level route helpers from rustdoc#162
Yong-yuan-X wants to merge 1 commit into
anthropics:mainfrom
Yong-yuan-X:fix/91-hide-manual-router-routes

Conversation

@Yong-yuan-X

Copy link
Copy Markdown
Contributor

Summary

  • hide all ten stringly-typed Router::route_* helpers from rustdoc while keeping them public for generated code
  • direct users toward the generated <Service>Ext::register API
  • replace manual routing examples and references in public documentation
  • clarify Router::with_spec behavior without hiding the typed API

This 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 -- --check
  • cargo clippy -p connectrpc --all-features --lib -- -D warnings
  • cargo test -p connectrpc --lib
  • cargo doc -p connectrpc --all-features --no-deps
  • cargo check -p multiservice-example --all-features
  • cargo check -p eliza-example --all-features

@github-actions

Copy link
Copy Markdown

All contributors have signed the CLA ✍️ ✅
Posted by the CLA Assistant Lite bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Router::route_* manual routing is stringly typed and surfaces in rustdoc before the codegen path

1 participant