-
Notifications
You must be signed in to change notification settings - Fork 12.9k
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
Deal with libcore/libstd doc duplication on primitives #30214
Labels
A-docs
Area: documentation for any part of the project, including the compiler, standard library, and tools
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
P-medium
Medium priority
T-libs-api
Relevant to the library API team, which will review and decide on the PR/issue.
Comments
(2) seems like the most pragmatic for the time being. |
I'd go for 2 as well. |
3 is really tough, but is gonna bit us with core docs anyway, for like... everything. 2 seems best here for now. |
Hm, so I can't actually find the doc pages for these traits. |
ghost
mentioned this issue
Feb 29, 2016
steveklabnik
added a commit
to steveklabnik/rust
that referenced
this issue
Mar 1, 2016
Hello. Quite a few of the links in the `core` module concerning redirection to additional primitive type documentation are broken. I noticed in rust-lang#30214 that there seemed to be a consensus with linking across to `std` module documentation from the `core` module. This is what I've done with the `core` modules for primitive types. If the changes here are good to go forward with, I'll happily tend to adding more documentation links for the extension traits in the aforementioned issue if need be. r? @steveklabnik
steveklabnik
added
the
A-docs
Area: documentation for any part of the project, including the compiler, standard library, and tools
label
Mar 10, 2017
steveklabnik
added
P-medium
Medium priority
T-libs-api
Relevant to the library API team, which will review and decide on the PR/issue.
and removed
A-docs
labels
Mar 22, 2017
Mark-Simulacrum
added
the
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
label
Jul 24, 2017
Update: these traits have been removed, and replaced by inherent impls. As such, this ticket is moot. Closing! |
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
C-enhancement
Category: An issue proposing an enhancement or a PR with one.
P-medium
Medium priority
T-libs-api
Relevant to the library API team, which will review and decide on the PR/issue.
Right now there are a number of extension traits in libcore that are being stabilized, including:
SliceExt
StrExt
CharExt
Float
These all currently have very little or no documentation because all the actual docs live elsewhere (e.g. libcollections, libstd, librustc_unicode, etc). When browsing the libcore-only docs, however, this may be a bit jarring, so we may want to resolve this somehow. A few strategies possible are:
I'd vote for route (2) personally.
The text was updated successfully, but these errors were encountered: