Use intra-doc links in core::ptr
#76497
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
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
added
A-intra-doc-links
|
(rust_highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
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
| ^^^^^^^^ |
jyn514
reviewed
Sep 9, 2020
|
I think I'll change the text to |
`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.
|
@bors r+ rollup |
|
📌 Commit d24026b has been approved by |
bors
added
S-waiting-on-bors
ollie27
reviewed
Sep 9, 2020
|
@bors r- |
bors
added
S-waiting-on-author
#safety -> self#safety
|
@rustbot modify labels: -S-waiting-on-author +S-waiting-on-review |
rustbot
added
S-waiting-on-review
|
@bors r+ rollup |
|
📌 Commit 884a1b4 has been approved by |
bors
added
S-waiting-on-bors
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`
|
@rustbot modify labels: merged-by-bors |
|
Error: Label merged-by-bors can only be set by Rust team members Please let |
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.
Part of #75080.
The only link that I did not change is a link to a function on the
pointerprimitive because intra-doc links for thepointerprimitivedon't work yet (see #63351).
@rustbot modify labels: A-intra-doc-links T-doc