rustdoc: Create anchor pages for primitive types #14513
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
|
Yay! The docs for |
|
This doesn't seem to handle tuples. |
| fn from_str(s: &str) -> Option<Primitive> { | ||
| match s.as_slice() { | ||
| "int" => Some(Int), | ||
| "i8" => Some(Int), |
There was a problem hiding this comment.
Fyi, Exhibit a is missing i8 and lists int twice and this might be the cause.
|
Updated with comments (will rebase upwards afterwards) |
7 tasks
|
ping r? |
|
r=me with comments |
|
Thanks @huonw for reviewing! |
bors
added a commit
that referenced
this pull request
May 31, 2014
This is currently rebased on top of #14478, but that's just to preemptively avoid rebase conflicts and to provide a better preview. This can land independently of that PR. This change crates a dedicated page in rustdoc for primitive types to outline everything you can do with them (at least in a basic way). * Preview - http://people.mozilla.org/~acrichton/doc/ * Exhibit A - http://people.mozilla.org/~acrichton/doc/std/#primitives * Exhibit B - http://people.mozilla.org/~acrichton/doc/std/primitive.str.html * Exhibit C - http://people.mozilla.org/~acrichton/doc/std/primitive.slice.html Please don't hesitate to be nitpickity, it's easy to overlook a thing here or there!
Instead of one giant function, this breaks it up into several smaller functions which have explicit dependencies among one another. There are no code changes as a result of this commit.
The cache is going to be used earlier in the HTML generation process, which means that it needs to get into TLS as soon as possible.
When inlining documentation across crates, primitive implementors of traits were not shown. This commit tweaks the infrastructure to treat primitive and Path-like impls the same way, displaying all implementors everywhere. cc rust-lang#14462
Type parameters were filled in for some areas, but not all. This commit unifies the two code paths to fill in type parameters everywhere. Closes rust-lang#14508
This commit adds support in rustdoc to recognize the `#[doc(primitive = "foo")]` attribute. This attribute indicates that the current module is the "owner" of the primitive type `foo`. For rustdoc, this means that the doc-comment for the module is the doc-comment for the primitive type, plus a signal to all downstream crates that hyperlinks for primitive types will be directed at the crate containing the `#[doc]` directive. Additionally, rustdoc will favor crates closest to the one being documented which "implements the primitive type". For example, documentation of libcore links to libcore for primitive types, but documentation for libstd and beyond all links to libstd for primitive types. This change involves no compiler modifications, it is purely a rustdoc change. The landing pages for the primitive types primarily serve to show a list of implemented traits for the primitive type itself. The primitive types documented includes both strings and slices in a semi-ad-hoc way, but in a way that should provide at least somewhat meaningful documentation. Closes rust-lang#14474
This prevents structures like RcBox from showing up in the documentation
There is currently no way to query all impls for a type from an external crate, and with primitive types in play this is also quite difficult. Instead of filtering, just suck in all impls from upstream crates into the local AST, and have them get stripped later. This will allow population of all implementations of traits for primitive types, as well as filling in some corner cases with inlining documentation in other cases.
Cross crate links can target items which are not rendered in the documentation. If the item is reexported at a higher level, the destination of the link (a concatenation of the fully qualified name) may actually lead to nowhere. This fixes this problem by altering rustdoc to emit pages which redirect to the local copy of the reexported structure. cc rust-lang#14515 Closes rust-lang#14137
These don't actually point to anything, so there's no need to inline them.
bors
added a commit
that referenced
this pull request
Jun 1, 2014
This is currently rebased on top of #14478, but that's just to preemptively avoid rebase conflicts and to provide a better preview. This can land independently of that PR. This change crates a dedicated page in rustdoc for primitive types to outline everything you can do with them (at least in a basic way). * Preview - http://people.mozilla.org/~acrichton/doc/ * Exhibit A - http://people.mozilla.org/~acrichton/doc/std/#primitives * Exhibit B - http://people.mozilla.org/~acrichton/doc/std/primitive.str.html * Exhibit C - http://people.mozilla.org/~acrichton/doc/std/primitive.slice.html Please don't hesitate to be nitpickity, it's easy to overlook a thing here or there!
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Jun 5, 2023
…2, r=Veykril doc(alias)-based completion round 2 Follow-up on rust-lang#14433 We can now complete fields, functions and some use/mods. Flyimports don't behave, I don't really have the time to understand the structure there either. While reading the flyimport code, I removed one method only used there, the closure-tree was a bit confusing, I can revert that if you want.
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.
This is currently rebased on top of #14478, but that's just to preemptively avoid rebase conflicts and to provide a better preview. This can land independently of that PR.
This change crates a dedicated page in rustdoc for primitive types to outline everything you can do with them (at least in a basic way).
Please don't hesitate to be nitpickity, it's easy to overlook a thing here or there!