4 ms·
Have there been documentation improvements? For instance http://doc.rust-lang.org/nightly/std/str/ http://doc.rust-lang.org/nightly/std/str/ is still quite obsc
by alricb 11y ago
Have there been documentation improvements? For instance http://doc.rust-lang.org/nightly/std/str/ http://doc.rust-lang.org/nightly/std/str/ is still quite obscure: it talks about the traits returned by certain methods, but there isn't an obvious way to get to the documentation for those methods, if you'd like to know how .lines() is different from .lines_any(), for example. Compare with https://docs.python.org/3/library/stdtypes.html#str https://docs.python.org/3/library/stdtypes.html#str where all the methods are listed, along with what they do.
- steveklabnik 11y agoThere have been a number of doc fixes, but they've largely been polish more than brand new things. I've had about ~50 PRs in this release myself, after a quick look, and we had a bunch of community stuff as well. The specific issue you're talking about is due to using Markdown rather than ReST, basically. We didn't manually link those methods, but probably could. In general, the API docs could use a lot of work. There's always so much more to do.
- gmjosack 11y agoYou probably want this page for str: http://doc.rust-lang.org/nightly/std/primitive.str.html http://doc.rust-lang.org/nightly/std/primitive.str.html It's unfortunate that most of the links navigate you to the less useful doc.
- bpicolo 11y agoI'm getting bizarre rendering errors in chrome for whatever character prefixes "self" in all those (I assume &?)
- kibwen 11y agoPeople were hitting that a few months ago, is this the first time that you've visited the docs in a while? In their case it was due to a problem with the page's font file itself, and it may be that your browser still has that version of the font cached. Maybe try a force-refresh?
- bpicolo 11y agoHmmm. Force refresh did nothing. It's possible I have Source Code Pro like the other commenter suggests. Dunno
- MetaCosm 11y agoIf you have an old version of "Source Code Pro" on your computer, it will WRECK that page in a lot of fun and interesting ways. You can either remove "Source Code Pro" from your box, or use Tampermonkey / Greasemonkey to remove it from the markup.
- eoi 11y agoI'd like to mention that I've been happy with the docs, once I learned to find them. To take the given example, I would start at http://doc.rust-lang.org/std/ http://doc.rust-lang.org/std/ and hit `s` to start a search. Searching for `str::lines` gives http://doc.rust-lang.org/std/primitive.str.html#method.lines http://doc.rust-lang.org/std/primitive.str.html#method.lines as the second result, which has the two methods conveniently next to each other, succinctly explains them, and shows an example of using each one. I've had good luck with docs for the few third party libraries I've tried so far too. The recommended doc generation creates pages in the same format as the std docs, so as you get comfortable navigating them you get comfortable navigating many third party docs as well.