docs(tonic-build): remove doc-difference between lib.rs and Readme
#2308
Conversation
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
CommanderStorm
commented
Jun 20, 2025
This comment was marked as resolved.
This comment was marked as resolved.
Sorry, something went wrong.
CommanderStorm
commented
Jun 20, 2025
CommanderStorm
changed the title
tonic-build's lib.rs and Readmelib.rs and Readme
tottoto
requested changes
Jun 22, 2025
Co-authored-by: tottoto <tottotodev@gmail.com>
tottoto
approved these changes
Jun 22, 2025
dfawley
added a commit
to dfawley/tonic
that referenced
this pull request
Jul 11, 2025
* chore: Use symbolic link for license file (hyperium#2241) * chore: Use inline format argument (hyperium#2260) * chore: Add `flake.nix` (hyperium#2261) * chore: Fix interop test certs (hyperium#2262) * chore: Fix interop test certs * fix bash script: * fix: tls config overwrite in endpoint (hyperium#2252) * fix: tls config overwrite in endpoint PR hyperium#1866 fixed the breaking change introduced in hyperium#1731, but resets the TLS config without checking if `tls` is set. This patch resolves the regression and restores expected behaviour. * fix: cargo fmt whitespace check --------- Co-authored-by: vigneshwar.sm <vigneshwar.sm@zohocorp.com> Co-authored-by: Lucio Franco <luciofranco14@gmail.com> * chore(tonic-bench): Fix failing bench (hyperium#2207) Co-authored-by: Lucio Franco <luciofranco14@gmail.com> * feat: expose creation of HealthService and HealthReporter (hyperium#2251) * Expose creation of HealthService and HealthReporter * add default impl for HealthReporter * [spr] initial version (hyperium#2264) Created using spr 1.3.6-beta.1 * Revert "[spr] initial version (hyperium#2264)" (hyperium#2265) * chore: Prepare `v0.13.1` release Reviewers: Pull Request: hyperium#2266 * chore: Disable unused tower feature (hyperium#2270) * chore(ci): Set RUSTFLAGS only on check job (hyperium#2271) * chore: Update to webpki-roots 1 (hyperium#2269) * chore(ci): Update to cargo-check-external-types 0.2 (hyperium#2272) * chore(ci): Set token permission to read (hyperium#2275) * chore(test): Remove cargo-machete config (hyperium#2278) * chore: Remove unused dependency (hyperium#2277) * feat: add support for tower's load-shed layer (hyperium#2189) Refs: hyperium#1616 * chore: box Status contents (hyperium#2253) (hyperium#2282) * chore: box Status contents (hyperium#2253) * chore: use private into_status method * chore(doc): Fix outdated limit in comment (hyperium#2297) * fix outdated limit in comment This mention was missed when the default changed in hyperium#1335 * Add backquotes Co-authored-by: tottoto <tottotodev@gmail.com> --------- Co-authored-by: tottoto <tottotodev@gmail.com> * feat: Update to prost 0.14 (hyperium#2300) * chore: Start development of version 0.14 (hyperium#2303) * chore(build): Make empty client and server modules private (hyperium#2291) Co-authored-by: Lucio Franco <luciofranco14@gmail.com> Co-authored-by: tottoto <tottotodev@gmail.com> * chore(test): Simplify skip debug test (hyperium#2305) * chore(ci): Exclude semver check of unreleased crate (hyperium#2304) * feat(types): Update error_details.proto to a56cbf3b (hyperium#2286) (hyperium#2306) * chore(test): Remove unnecessary prost-build dependency (hyperium#2307) * feat(transport): Allow setting TCP_KEEPINTVL and TCP_KEEPCNT (hyperium#2299) * Allow setting TCP_KEEPINTVL and TCP_KEEPCNT * fix windows * fix clippy windows * fix(tonic): make `Streaming` `Sync` again (hyperium#2293) The boxed `Decoder` inside `Streaming` need not be `Sync` since hyperium#804. Unfortunately, that makes `Streaming` non-`Sync`, meaning that all the generated `tonic` futures cannot be awaited in `Sync` futures. In fact, the only times we use the `Decoder`, we have a `&mut` unique reference to it, so we are guaranteed not to require synchronization. The `sync_wrapper` crate encodes this reasoning, allowing us to safely make the `Streaming` type `Sync` regardless of whether the contained `Decoder` is `Sync` or not. * feat: preserve user-agent header (hyperium#2290) Co-authored-by: Lucio Franco <luciofranco14@gmail.com> * chore: Make publish script portable (hyperium#2313) * feat(tls): Add tls handshake timeout support (hyperium#2309) Co-authored-by: tottoto <tottotodev@gmail.com> * docs(tonic-build): remove doc-difference between `lib.rs` and Readme (hyperium#2308) * doc: try to improve the doc-disparity between `tonic-build`'s `lib.rs` and the readme * Fix indentation * fix the doctests * fix a typo and retes an assumption * Change `compile_fail` to `ignore` Co-authored-by: tottoto <tottotodev@gmail.com> --------- Co-authored-by: tottoto <tottotodev@gmail.com> * Merge changes from next to master branch (hyperium#2315) Co-authored-by: Arjan Singh Bal <46515553+arjan-bal@users.noreply.github.com> Co-authored-by: Easwar Swaminathan <easwars@google.com> * chore(interop): Update to console 0.16 (hyperium#2318) * chore(test): Remove unnecessary tokio-stream dependency (hyperium#2311) * chore(test): Refactor default stubs test (hyperium#2310) * chore(test): Use tempfile crate to handle temporary file (hyperium#2325) * chore(grpc): Update to rand 0.9 (hyperium#2324) --------- Co-authored-by: tottoto <tottotodev@gmail.com> Co-authored-by: Lucio Franco <luciofranco14@gmail.com> Co-authored-by: Vigneshwar S <80331703+vigneshs-12@users.noreply.github.com> Co-authored-by: vigneshwar.sm <vigneshwar.sm@zohocorp.com> Co-authored-by: Rafael RL <Rafael.Ruiz-Lucena@etas.com> Co-authored-by: Leon Hartley <lhartley97@gmail.com> Co-authored-by: Joe Roback <joeroback@users.noreply.github.com> Co-authored-by: Raphael Taylor-Davies <1781103+tustvold@users.noreply.github.com> Co-authored-by: Alexis Darrasse <121769912+darrasse@users.noreply.github.com> Co-authored-by: Alex Steele <45648397+ADSteele916@users.noreply.github.com> Co-authored-by: Kristopher Wuollett <kristopher.wuollett@gmail.com> Co-authored-by: Makro <4398091+xmakro@users.noreply.github.com> Co-authored-by: James Kay <twey@twey.co.uk> Co-authored-by: Darren Bolduc <dbolduc@google.com> Co-authored-by: Honsun Zhu <honsun@linux.com> Co-authored-by: Frank Elsinga <frank@elsinga.de> Co-authored-by: Arjan Singh Bal <46515553+arjan-bal@users.noreply.github.com> Co-authored-by: Easwar Swaminathan <easwars@google.com>
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.
Note
Due to apparent newer github changes, reopening PRs is not a feautre.
Opening a duplicate for this docs change is best I can do
Previous PR: #2035 (comment)
Motivation
I had a bit of a hard time figuring out the getting started guide.
This PR tries to improve a bit on these shortcomings:
Solution
lib.rsand Readme to avoid getting to the same place in a few months