Add missing doc links in boxed module #62310
Conversation
rust-highfive
added
the
S-waiting-on-review
src/liballoc/boxed.rs
Outdated
| @@ -1,6 +1,6 @@ | |||
| //! A pointer type for heap allocation. | |||
| //! | |||
| //! `Box<T>`, casually referred to as a 'box', provides the simplest form of | |||
| //! [`Box<T>`][Box], casually referred to as a 'box', provides the simplest form of | |||
There was a problem hiding this comment.
Is this link right? Below it is:
//! [`Box`]: struct.Box.html
There was a problem hiding this comment.
I wanted to test if the auto linkage was working but apparently it's not. :'(
src/liballoc/boxed.rs
Outdated
| @@ -48,7 +48,7 @@ | |||
| //! | |||
| //! It wouldn't work. This is because the size of a `List` depends on how many | |||
| //! elements are in the list, and so we don't know how much memory to allocate | |||
| //! for a `Cons`. By introducing a `Box`, which has a defined size, we know how | |||
| //! for a `Cons`. By introducing a [`Box`], which has a defined size, we know how | |||
There was a problem hiding this comment.
No reason to add the "<T>". Or maybe I missed something?
There was a problem hiding this comment.
Well it's the convention to use <T>; https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#referring-to-types
There was a problem hiding this comment.
Ah then I'll add it. :)
GuillaumeGomez
force-pushed
the
add-missing-doc-links-boxed
branch
from
30cab1c
to
f3a5d91
Compare
GuillaumeGomez
force-pushed
the
add-missing-doc-links-boxed
branch
from
f3a5d91
to
63f2c22
Compare
|
There are still some |
|
@QuietMisdreavus I answered to you there and I disagree with your point of view. I'll let you answer on the original thread. :) |
|
ping from triage @Centril, could you take another look at this? |
|
r? @Centril @bors r+ rollup (For the same reasons as I noted in #62120 (comment), feel free to unapprove if you disagree.) |
|
📌 Commit 63f2c22 has been approved by |
bors
added
S-waiting-on-bors
…s-boxed, r=Centril Add missing doc links in boxed module r? @rust-lang/docs
…s-boxed, r=Centril Add missing doc links in boxed module r? @rust-lang/docs
Rollup of 22 pull requests Successful merges: - #62084 (allow clippy::unreadable_literal in unicode tables) - #62120 (Add missing type links in documentation) - #62310 (Add missing doc links in boxed module) - #62421 (Introduce `as_deref` to Option) - #62583 (Implement Unpin for all raw pointers) - #62692 (rustc: precompute the largest Niche and store it in LayoutDetails.) - #62801 (Remove support for -Zlower-128bit-ops) - #62828 (Remove vector fadd/fmul reduction workarounds) - #62862 (code cleanup) - #62904 (Disable d32 on armv6 hf targets) - #62907 (Initialize the MSP430 AsmParser) - #62956 (Implement slow-path for FirstSets::first) - #62963 (Allow lexer to recover from some homoglyphs) - #62964 (clarify and unify some type test names) - #62970 (ci: gate toolstate repo pushes on the TOOLSTATE_PUBLISH envvar) - #62980 (std: Add more accessors for `Metadata` on Windows) - #62983 (Remove needless indirection through Rc) - #62985 (librustc_errors: Support ui-testing flag in annotate-snippet emitter) - #63002 (error_index_generator should output stdout/stderr when it panics.) - #63004 (Add test for issue-54062) - #63007 (ci: debug network failures while downloading awscli from PyPI) - #63009 (Remove redundant `mut` from variable declaration.) Failed merges: r? @ghost
r? @rust-lang/docs