Examples are not Documentation (nereux.blog)

submitted 7 months ago by Nereuxofficial@programming.dev to c/rust@programming.dev

16 comments fedilink hide all child comments

you are viewing a single comment's thread
view the rest of the comments

[-] BB_C@programming.dev 51 points 6 months ago* (last edited 6 months ago)

Examples ARE usage documentation.

What value is this blog supposed to be adding exactly?
The fact that top-level and API descriptive explanations are important?
The fact that some projects don't have complete documentation?
To whom exactly would this be considered new information?

[-] pkill@programming.dev 20 points 6 months ago

This. I can't count HOW MANY FUCKING TIMES I had to either look up the source code or search GitHub for code using a function from a given library because the documentation was so laconic and/or disjointed.

this post was submitted on 03 May 2024

44 points (81.4% liked)

Rust

6055 readers

162 users here now

Welcome to the Rust community! This is a place to discuss about the Rust programming language.

Wormhole

!performance@programming.dev

Credits

The icon is a modified version of the official rust logo (changing the colors to a gradient and black background)

founded 1 year ago

MODERATORS

snowe@programming.dev

Ategon@programming.dev

EdTheLegendary@programming.dev

kahnclusions@programming.dev

torcherist@programming.dev