docs: replace method links with intra-links #2540
Merged
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
|
Blocked by rust-lang/rust#71289 |
Darksonn
reviewed
May 16, 2020
Darksonn
added
A-tokio
taiki-e
reviewed
May 20, 2020
ghost
marked this pull request as ready for review
|
It's ready for review @Darksonn |
ghost
commented
May 24, 2020
ghost
commented
May 24, 2020
|
No idea why it fails - I'll check it later [23:43:37] xliiv@alef /home/xliiv/workspace/tokio (0)
> env RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features
Finished dev [unoptimized + debuginfo] target(s) in 0.09s
[23:43:39] xliiv@alef /home/xliiv/workspace/tokio (0)
> rustc +nightly --version
rustc 1.45.0-nightly (8970e8bcf 2020-05-23)
[23:43:45] xliiv@alef /home/xliiv/workspace/tokio (0)
> git show --summary
commit 03510730bc563091b83ea3aabb75146df04d1b6f (HEAD -> 1473-fix-links, xliiv/1473-fix-links)
Author: Tymoteusz Jankowski <tymoteusz.jankowski@gmail.com>
Date: Fri May 22 22:07:20 2020 +0200
docs: replace method links with intra-links
|
|
CI failure is due to our CI using old nightly rustc: Line 6 in 954f2b7 |
|
@taiki-e is there an upgrade policy? can i upgrade? |
|
I don't think there's an official policy, but we should probably verify that docs.rs uses a similarly new nightly to compile their docs. If they are, I think it is fine to go ahead an update it. |
|
@Darksonn it should be ok, according to this
|
|
Just upgraded, let's see if it works now.. BTW I've made it 2 commits on purpose (one extra for the upgrade). Let me know if it's OK. |
|
It looks good. I commented on the registration thing, and it appears to be rather easy to fix. Once that's changed, we can merge it. |
|
@Darksonn, it seems |
Darksonn
approved these changes
May 30, 2020
jensim
pushed a commit
to jensim/tokio
that referenced
this pull request
Jun 7, 2020
hawkw
added a commit
that referenced
this pull request
Jul 20, 2020
- docs: misc improvements (#2572, #2658, #2663, #2656, #2647, #2630, #2487, #2621, #2624, #2600, #2623, #2622, #2577, #2569, #2589, #2575, #2540, #2564, #2567, #2520, #2521, #2572, #2493) - rt: allow calls to `block_on` inside calls to `block_in_place` that are themselves inside `block_on` (#2645) - net: fix non-portable behavior when dropping `TcpStream` `OwnedWriteHalf` (#2597) - io: improve stack usage by allocating large buffers on directly on the heap (#2634) - io: fix unsound pin projection in `AsyncReadExt::read_buf` and `AsyncWriteExt::write_buf` (#2612) - io: fix unnecessary zeroing for `AsyncRead` implementors (#2525) - io: Fix `BufReader` not correctly forwarding `poll_write_buf` (#2654) - coop: returning `Poll::Pending` no longer decrements the task budget (#2549) - io: little-endian variants of `AsyncReadExt` and `AsyncWriteExt` methods (#1915) - io: fix panic in `AsyncReadExt::read_line` (#2541) - task: add [`tracing`] instrumentation to spawned tasks (#2655) - sync: allow unsized types in `Mutex` and `RwLock` (via `default` constructors) (#2615) - net: add `ToSocketAddrs` implementation for `&[SocketAddr]` (#2604) - fs: add `OpenOptionsExt` for `OpenOptions` (#2515) - fs: add `DirBuilder` (#2524) [`tracing`]: https://crates.io/crates/tracing Signed-off-by: Eliza Weisman <eliza@buoyant.io>
hawkw
added a commit
that referenced
this pull request
Jul 22, 2020
# 0.2.22 (July 2!, 2020) ### Fixes - docs: misc improvements (#2572, #2658, #2663, #2656, #2647, #2630, #2487, #2621, #2624, #2600, #2623, #2622, #2577, #2569, #2589, #2575, #2540, #2564, #2567, #2520, #2521, #2493) - rt: allow calls to `block_on` inside calls to `block_in_place` that are themselves inside `block_on` (#2645) - net: fix non-portable behavior when dropping `TcpStream` `OwnedWriteHalf` (#2597) - io: improve stack usage by allocating large buffers on directly on the heap (#2634) - io: fix unsound pin projection in `AsyncReadExt::read_buf` and `AsyncWriteExt::write_buf` (#2612) - io: fix unnecessary zeroing for `AsyncRead` implementors (#2525) - io: Fix `BufReader` not correctly forwarding `poll_write_buf` (#2654) - io: fix panic in `AsyncReadExt::read_line` (#2541) ### Changes - coop: returning `Poll::Pending` no longer decrements the task budget (#2549) ### Added - io: little-endian variants of `AsyncReadExt` and `AsyncWriteExt` methods (#1915) - task: add [`tracing`] instrumentation to spawned tasks (#2655) - sync: allow unsized types in `Mutex` and `RwLock` (via `default` constructors) (#2615) - net: add `ToSocketAddrs` implementation for `&[SocketAddr]` (#2604) - fs: add `OpenOptionsExt` for `OpenOptions` (#2515) - fs: add `DirBuilder` (#2524) [`tracing`]: https://crates.io/crates/tracing Signed-off-by: Eliza Weisman <eliza@buoyant.io>
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.
Motivation
Make doc's links more resistant.
Solution
Delagates doc's links resolution to
rustdoc.Refs: #1473