Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing doc links in boxed module #62310

Merged
merged 1 commit into from
Jul 26, 2019

Conversation

GuillaumeGomez
Copy link
Member

r? @rust-lang/docs

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 2, 2019
@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this link right? Below it is:

//! [`Box`]: struct.Box.html 

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wanted to test if the auto linkage was working but apparently it's not. :'(

@@ -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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should be Box<T> here?

Copy link
Member Author

@GuillaumeGomez GuillaumeGomez Jul 2, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No reason to add the "<T>". Or maybe I missed something?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah then I'll add it. :)

@QuietMisdreavus
Copy link
Member

There are still some Boxes without the <T> on lines 56-57. However, that paragraph also runs against the argument i made in #62120 (comment), namely that i fail to see the usefulness of having multiple links to the same type (using the same link name) in the same paragraph.

@GuillaumeGomez
Copy link
Member Author

@QuietMisdreavus I answered to you there and I disagree with your point of view. I'll let you answer on the original thread. :)

@hdhoang
Copy link
Contributor

hdhoang commented Jul 26, 2019

ping from triage @Centril, could you take another look at this?

@Centril
Copy link
Contributor

Centril commented Jul 26, 2019

r? @Centril @bors r+ rollup (For the same reasons as I noted in #62120 (comment), feel free to unapprove if you disagree.)

@bors
Copy link
Contributor

bors commented Jul 26, 2019

📌 Commit 63f2c22 has been approved by Centril

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 26, 2019
Centril added a commit to Centril/rust that referenced this pull request Jul 26, 2019
…s-boxed, r=Centril

Add missing doc links in boxed module

r? @rust-lang/docs
Centril added a commit to Centril/rust that referenced this pull request Jul 26, 2019
…s-boxed, r=Centril

Add missing doc links in boxed module

r? @rust-lang/docs
bors added a commit that referenced this pull request Jul 26, 2019
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
@bors bors merged commit 63f2c22 into rust-lang:master Jul 26, 2019
@GuillaumeGomez GuillaumeGomez deleted the add-missing-doc-links-boxed branch July 27, 2019 09:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants