rustdoc-json-types: Document Id
#125130
Merged
rustdoc-json-types: Document Id
#125130
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
rustbot
added
A-rustdoc-json
|
rustdoc-json-types is a public (although nightly-only) API. If possible, consider changing |
obi1kenobi
reviewed
May 14, 2024
src/rustdoc-json-types/lib.rs
Outdated
Comment on lines
199
to
201
| /// Rustdoc makes no guarantees about the inner value of Id's. Applications | ||
| /// should treat them as opaque keys to lookup items, and avoid attempting | ||
| /// to parse them, or otherwise really on implementation details. |
There was a problem hiding this comment.
Suggested change
| /// Rustdoc makes no guarantees about the inner value of Id's. Applications | |
| /// should treat them as opaque keys to lookup items, and avoid attempting | |
| /// to parse them, or otherwise really on implementation details. | |
| /// Rustdoc makes no guarantees about the inner value of Id's. Applications | |
| /// should treat them as opaque keys to lookup items, and avoid attempting | |
| /// to parse them, or otherwise depending on any implementation details. |
grammar fix
GuillaumeGomez
approved these changes
May 14, 2024
There was a problem hiding this comment.
Nice improvement! Once @obi1kenobi's comment is applied, r=me
rust-cloud-vms
bot
force-pushed
the
id-docs
branch
from
3bf7264
to
504bca9
Compare
|
@bors r=GuillaumeGomez rollup |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 16, 2024
…iaskrgr Rollup of 5 pull requests Successful merges: - rust-lang#124871 (Don't ICE because recomputing overflow goals during find_best_leaf_obligation causes inference side-effects) - rust-lang#125018 (Update linker-plugin-lto.md to include LLVM 18) - rust-lang#125130 (rustdoc-json-types: Document `Id`) - rust-lang#125170 (Uplift `FnSig` into `rustc_type_ir` (redux)) - rust-lang#125172 (Fix assertion when attempting to convert `f16` and `f128` with `as`) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 16, 2024
Rollup merge of rust-lang#125130 - aDotInTheVoid:id-docs, r=GuillaumeGomez rustdoc-json-types: Document `Id` Inspired by finding [someone looking into the internals of an id](rust-lang#91609 (comment)), I realized we only document the fact that these are opaque on [the rfc](https://rust-lang.github.io/rfcs/2963-rustdoc-json.html#id). r? `@GuillaumeGomez`
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.
Inspired by finding someone looking into the internals of an id, I realized we only document the fact that these are opaque on the rfc.
r? @GuillaumeGomez