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

Use intra-doc links in core::ptr #76497

Merged
merged 3 commits into from
Sep 10, 2020

Conversation

camelid
Copy link
Member

@camelid camelid commented Sep 8, 2020

Part of #75080.

The only link that I did not change is a link to a function on the
pointer primitive because intra-doc links for the pointer primitive
don't work yet (see #63351).


@rustbot modify labels: A-intra-doc-links T-doc

The only link that I did not change is a link to a function on the
`pointer` primitive because intra-doc links for the `pointer` primitive
don't work yet (see rust-lang#63351).
@rustbot rustbot added A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools labels Sep 8, 2020
@rust-highfive
Copy link
Collaborator

r? @LukasKalbertodt

(rust_highfive has picked a reviewer for you, use r? to override)

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Sep 8, 2020
@jyn514
Copy link
Member

jyn514 commented Sep 9, 2020

 error: `write` is both a function and a macro
   --> library/core/src/ptr/mod.rs:132:13
    |
132 | /// again. [`write`] can be used to overwrite data without causing it to be
    |             ^^^^^^^ ambiguous link
    |
    = note: `-D broken-intra-doc-links` implied by `-D warnings`
help: to link to the function, add parentheses
    |
132 | /// again. [`write()`] can be used to overwrite data without causing it to be
    |             ^^^^^^^^^
help: to link to the macro, add an exclamation mark
    |
132 | /// again. [`write!`] can be used to overwrite data without causing it to be
    |             ^^^^^^^^

Copy link
Member

@jyn514 jyn514 left a comment

Choose a reason for hiding this comment

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

r=me with nit fixed and CI passing

library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved
@jyn514 jyn514 assigned jyn514 and unassigned LukasKalbertodt Sep 9, 2020
@camelid
Copy link
Member Author

camelid commented Sep 9, 2020

I think I'll change the text to [`write()`] to fix the error. Does that sound good?

`write` is ambiguous because there's also a macro called `write`.

Also removed unnecessary and potentially confusing link to a function in
its own docs.
@jyn514
Copy link
Member

jyn514 commented Sep 9, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 9, 2020

📌 Commit d24026b has been approved by jyn514

@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 Sep 9, 2020
library/core/src/ptr/mod.rs Outdated Show resolved Hide resolved
@ollie27
Copy link
Member

ollie27 commented Sep 9, 2020

@bors r-

@bors bors added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. labels Sep 9, 2020
#safety -> self#safety
@camelid
Copy link
Member Author

camelid commented Sep 9, 2020

@rustbot modify labels: -S-waiting-on-author +S-waiting-on-review

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels Sep 9, 2020
@jyn514
Copy link
Member

jyn514 commented Sep 10, 2020

@bors r+ rollup

@bors
Copy link
Contributor

bors commented Sep 10, 2020

📌 Commit 884a1b4 has been approved by jyn514

@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 Sep 10, 2020
tmandry added a commit to tmandry/rust that referenced this pull request Sep 10, 2020
…r, r=jyn514

Use intra-doc links in `core::ptr`

Part of rust-lang#75080.

The only link that I did not change is a link to a function on the
`pointer` primitive because intra-doc links for the `pointer` primitive
don't work yet (see rust-lang#63351).

---

@rustbot modify labels: A-intra-doc-links T-doc
bors added a commit to rust-lang-ci/rust that referenced this pull request Sep 10, 2020
Rollup of 7 pull requests

Successful merges:

 - rust-lang#74787 (Move `rustllvm` into `compiler/rustc_llvm`)
 - rust-lang#76458 (Add drain_filter method to HashMap and HashSet)
 - rust-lang#76472 (rustbuild: don't set PYTHON_EXECUTABLE and WITH_POLLY cmake vars since they are no longer supported by llvm)
 - rust-lang#76497 (Use intra-doc links in `core::ptr`)
 - rust-lang#76500 (Add -Zgraphviz_dark_mode and monospace font fix)
 - rust-lang#76543 (Document btree's unwrap_unchecked)
 - rust-lang#76556 (Revert rust-lang#76285)

Failed merges:

r? `@ghost`
@bors bors merged commit d013e60 into rust-lang:master Sep 10, 2020
@rustbot rustbot added this to the 1.48.0 milestone Sep 10, 2020
@camelid camelid deleted the intra-doc-links-for-core-ptr branch September 11, 2020 01:57
@camelid
Copy link
Member Author

camelid commented Sep 11, 2020

@rustbot modify labels: merged-by-bors

@rustbot
Copy link
Collaborator

rustbot commented Sep 11, 2020

Error: Label merged-by-bors can only be set by Rust team members

Please let @rust-lang/release know if you're having trouble with this bot.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation for any part of the project, including the compiler, standard library, and tools A-intra-doc-links Area: Intra-doc links, the ability to link to items in docs by name 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.

7 participants