this post was submitted on 03 May 2024
44 points (81.4% liked)

Rust

5989 readers
33 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
44
Examples are not Documentation (nereux.blog)
submitted 6 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
[โ€“] sugar_in_your_tea@sh.itjust.works 40 points 6 months ago (1 children)

The only thing worse than a bad example is documentation like this:

fn do_thing(...)

Does thing.

It adds nothing, other than letting you know they were there and decided not to actually provide something useful.

[โ€“] Nereuxofficial@programming.dev 7 points 6 months ago

Yeah that just wastes both people's time