Edit rustc_span documentation #80358
Merged
+71
−46
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
|
r? @lcnr (rust-highfive has picked a reviewer for you, use r? to override) |
rust-highfive
added
the
S-waiting-on-review
pierwill
commented
Dec 24, 2020
jyn514
reviewed
Dec 24, 2020
jyn514
added
the
T-compiler
|
@bors r+ rollup |
|
📌 Commit a8791255b1a212722c4e80f6ad5b2a95547b0890 has been approved by |
bors
added
S-waiting-on-bors
Various changes to the `rustc_span` docs, including the following: - Additions to top-level docs - Edits to the source_map module docs - Edits to documentation for `Span` and `SpanData` - Added intra-docs links - Documentation for Levenshtein distances - Fixed missing punctuation
| @@ -124,7 +133,7 @@ pub enum RealFileName { | |||
|
|
|||
| impl RealFileName { | |||
| /// Returns the path suitable for reading from the file system on the local host. | |||
| /// Avoid embedding this in build artifacts; see `stable_name` for that. | |||
| /// Avoid embedding this in build artifacts; see `stable_name()` for that. | |||
There was a problem hiding this comment.
Is there a fixed convention for this? The old comment was referring to a function by name, which seems more correct. If there isn’t a well understood convention I could imagine someone else coming along and making the opposite changes as part of a similar comment tidying exercise.
There was a problem hiding this comment.
i don't think that we have a fixed convention for this
If there isn’t a well understood convention I could imagine someone else coming along and making the opposite changes as part of a similar comment tidying exercise.
yeah 🤷 i mostly just don't mind either way so asking people to remove/add changes like this seems slightly too pedantic to me.
|
@bors r+ rollup |
|
📌 Commit a8775d4 has been approved by |
GuillaumeGomez
added a commit
to GuillaumeGomez/rust
that referenced
this pull request
Dec 29, 2020
Edit rustc_span documentation Various changes to the `rustc_span` docs, including the following: - Additions to top-level docs - Edits to the source_map module docs - Edits to documentation for `Span` and `SpanData` - Added intra-docs links - Documentation for Levenshtein distances - Fixed missing punctuation
Dylan-DPC-zz
pushed a commit
to Dylan-DPC-zz/rust
that referenced
this pull request
Dec 30, 2020
Edit rustc_span documentation Various changes to the `rustc_span` docs, including the following: - Additions to top-level docs - Edits to the source_map module docs - Edits to documentation for `Span` and `SpanData` - Added intra-docs links - Documentation for Levenshtein distances - Fixed missing punctuation
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Dec 30, 2020
Rollup of 13 pull requests Successful merges: - rust-lang#79812 (Lint on redundant trailing semicolon after item) - rust-lang#80348 (remove redundant clones (clippy::redundant_clone)) - rust-lang#80358 (Edit rustc_span documentation) - rust-lang#80457 (Add missing commas to `rustc_ast_pretty::pp` docs) - rust-lang#80461 (Add llvm-libunwind change to bootstrap CHANGELOG) - rust-lang#80464 (Use Option::map_or instead of open coding it) - rust-lang#80465 (Fix typo in ffi-pure.md) - rust-lang#80467 (More uses of the matches! macro) - rust-lang#80469 (Fix small typo in time comment) - rust-lang#80472 (Use sans-serif font for the "all items" page links) - rust-lang#80477 (Make forget intrinsic safe) - rust-lang#80482 (don't clone copy types) - rust-lang#80487 (don't redundantly repeat field names) Failed merges: r? `@ghost` `@rustbot` modify labels: rollup
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.
Various changes to the
rustc_spandocs, including the following:SpanandSpanData