Fix broken documentation links #470
Closed
Conversation
This file contains 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
hlb8122
commented
Sep 21, 2020
| @@ -11,7 +11,7 @@ | |||
| //! A layer decorates an service and provides additional functionality. It | |||
| //! allows other services to be composed with the service that implements layer. | |||
| //! | |||
| //! A middleware implements the [`Layer`] and [`Service`] trait. | |||
| //! A middleware implements the [`Layer`] and [`Service`](tower_service::Service) trait. | |||
There was a problem hiding this comment.
This still won't work until https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md is merged.
hawkw
approved these changes
Dec 23, 2020
| @@ -11,7 +11,7 @@ | |||
| //! A layer decorates an service and provides additional functionality. It | |||
| //! allows other services to be composed with the service that implements layer. | |||
| //! | |||
| //! A middleware implements the [`Layer`] and [`Service`] trait. | |||
| //! A middleware implements the [`Layer`] and [`Service`](tower_service::Service) trait. | |||
There was a problem hiding this comment.
I'd prefer to put these link references at the end of the doc comment, rather than inline, like
//! A middleware implements the [`Layer`] and [`Service`] trait.
...
//! [`Service`]: tower_service::Service
Comment on lines
+11
to
+19
| /// [`MakeService`](crate::make::MakeService) in that it takes service _descriptors_ (see | ||
| /// `Target` on `MakeService`) and produces _services_. Since [`Balance`] spreads requests across a | ||
| /// _set_ of services, the inner service should produce a [`Discover`], not just a single | ||
| /// [`Service`], given a service descriptor. | ||
| /// [`Service`](tower_service::Service), given a service descriptor. | ||
| /// | ||
| /// See the [module-level documentation](..) for details on load balancing. | ||
| /// | ||
| /// [`Balance`]: crate::balance::p2c::service::Balance | ||
| /// [`Discover`]: crate::discover::Discover |
There was a problem hiding this comment.
This doc comment has a mix of inline and trailing link references. Can we try use one style consistently, please?
|
I took care of all the broken links while making other docs changes in PR #490, so I'm going to go ahead and close this now. Thanks for working on it, though! |
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.
Fixes
...::make_service::...links.crate::...