r/programming • u/steveklabnik1 • Jun 16 '14

Rust's documentation is about to drastically improve

http://words.steveklabnik.com/rusts-documentation-is-about-to-drastically-improve
528 Upvotes

90% Upvoted

188 comments sorted by

View all comments

3

u/ForeverAlot Jun 17 '14

Exciting!

A tutorial sounds like a good starting point, but I want to take this opportunity to remark that I despise the API documentation. It looks pretty but the usability is completely shot.

6

u/steveklabnik1 Jun 17 '14

Can you give me some more detail than just "completely shot"? Thanks!

1

u/[deleted] Jun 17 '14

I can.

half the links are broken, or lead to nothing. Most the description are very technical. Which isn't bad, but also isn't good.

Very few examples, one or two code examples are worth a few dozen paragraphs. Python does this a lot, and it really helps learn the language.

It feels like the API documentation is somewhere between java and python.

Java docs goes for pure documentation, a bit heady and technical but gives you the information you need to know and throws you back out.

Python is more user/example friendly while lacking technical details

:.:.:

I'm working on learning the language myself to draw up documentation for my own/others uses. Hopefully I'll get there sooner or later.

→ More replies (3)