You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I needed a method to replace some text in a string. Searching rustdoc for "replace" did not yield any result. After 5 minutes of looking around I finally found it after using the "[src]" link of the std::str docs and employing Ctrl+F to search the source. Only when I noticed that the method was defined on the primitive str type, did I remember that primitives are documented separately.
I already have experience in navigating rustdoc, but it still took me a considerable amount of time to find what I was looking for. The topic of hard to find documentation on strings was already the subject #22902, which resulted in two tiny links being added to the docs of std::str.
I think at the very least std::str should prominently link to the str primitive, mentioning specifically that additional methods are documented there.
Even better in my opinion would be if primitives and their methods could be found using rustdoc's search, maybe under a pseudo module (ie. primitive::str::replace).
The text was updated successfully, but these errors were encountered:
We have four or five related issues ipen about primitives, and also one about Deref coercions. (That's more of a 👍 than a 'this is invalid', it's certainly a pain point)
Anyway, cool, wasn't sure if there was something additional here. I really like the intermediate solution of linking to the primitive page from the module page.
I filtered using the A-docs label instead of A-rustdoc...
It's all good. generally, A-docs is docs that need to be written, which is what this looks like at first. :)
I needed a method to replace some text in a string. Searching rustdoc for "replace" did not yield any result. After 5 minutes of looking around I finally found it after using the "[src]" link of the
std::str
docs and employingCtrl+F
to search the source. Only when I noticed that the method was defined on the primitive str type, did I remember that primitives are documented separately.I already have experience in navigating rustdoc, but it still took me a considerable amount of time to find what I was looking for. The topic of hard to find documentation on strings was already the subject #22902, which resulted in two tiny links being added to the docs of
std::str
.I think at the very least
std::str
should prominently link to the str primitive, mentioning specifically that additional methods are documented there.Even better in my opinion would be if primitives and their methods could be found using rustdoc's search, maybe under a pseudo module (ie.
primitive::str::replace
).The text was updated successfully, but these errors were encountered: