Silver's Home
  • Communities
  • Create Post
  • heart
    Support Lemmy
  • search
    Search
  • Login
  • Sign Up
@Nereuxofficial@programming.dev to Rust@programming.dev • 1 year ago

Examples are not Documentation

nereux.blog

external-link
message-square
17
fedilink
45
external-link

Examples are not Documentation

nereux.blog

@Nereuxofficial@programming.dev to Rust@programming.dev • 1 year ago
message-square
17
fedilink
How to improve your documentation for Rust projects
  • @sugar_in_your_tea@sh.itjust.works
    link
    fedilink
    40•1 year ago

    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.devOP
      link
      fedilink
      7•1 year ago

      Yeah that just wastes both people’s time

Rust@programming.dev

!rust@programming.dev

Subscribe from Remote Instance

Create a post
You are not logged in. However you can subscribe from another Fediverse account, for example Lemmy or Mastodon. To do this, paste the following into the search field of your instance: !rust@programming.dev

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)
  • 31 users / day
  • 171 users / week
  • 387 users / month
  • 2.84K users / 6 months
  • 6.91K subscribers
  • 943 Posts
  • 4.37K Comments
  • Modlog
  • mods:
  • snowe
  • Ategon
  • EdTheLegendary
  • @kahnclusions@programming.dev
  • @torcherist@programming.dev
  • BE: 0.19.3
  • Modlog
  • Instances
  • Docs
  • Code
  • join-lemmy.org