• southerntofu@lemmy.ml
    link
    fedilink
    arrow-up
    3
    ·
    3 years ago

    That’s also why i love the rust ecosystem. If you have rust installed and have your local dependencies (or only use the standard library), the docs can be generated locally (cargo doc). I certainly remember local manuals helping me out more than once over the years :)

    • Skull giver@popplesburger.hilciferous.nl
      link
      fedilink
      English
      arrow-up
      2
      ·
      1 year ago

      It’s a great feature, but the Rust documentation generally assumes you have a great amount of in-depth knowledge about the language and the specific library you’re using. Often all you’re getting is a list of methods, struts, and traits, and brief descriptions like “frobble_widget frobbles the widget assuming the requirements are met”.

      I find the documentation on PHP libraries often a lot better. Technically both support generating the docs from the source code, but the Rust people seem to write worse documentation somehow.

      A real shame, because the documentation can contain quick tests that can serve as excellent example code!

    • ladydascalie@beehaw.org
      link
      fedilink
      arrow-up
      1
      ·
      1 year ago

      Go does this too, and I believe a couple other modern languages do too. Seems like the need for it is real and has been recognised by language authors