• Madrigal@lemmy.world
    link
    fedilink
    English
    arrow-up
    67
    arrow-down
    1
    ·
    1 year ago

    Most READMEs are terrible. The biggest issue many of them make is failing to include one or two simple examples.

    • mestari@lemmy.world
      link
      fedilink
      arrow-up
      11
      ·
      1 year ago

      Exactly! It’s so frustrating. I mainly deal with Eurocode, not computer code but the issue exists there too. It’s so vague that there’s whole another industry of people trying to decipher and explain what the code means and how it’s applied. The lack of examples have really driven people to insanity lol. In structural engineering there’s often no easy ways to test if your results are correct or not if you misunderstood the code…

    • cheery_coffee@lemmy.ca
      link
      fedilink
      arrow-up
      9
      ·
      1 year ago

      Why do I need a readme, I put the name of each function argument in the docstring and now have 100% coverage?