Documentation is indeed crazy

Source: Instagram

@jAsE I can feel you.

Everyone wants it to be good.

Everytime I've written actual docs and not just generated markdown ..

I get told it would be better if I just left it out and pointed to the test suite..

@lotd It depends.
The easiest way if you are running out of time is to have minimal docstring.

@jAsE that's true. I'm no exception.

@github example of a minimal doc string

@lotd not ideal. But nowadays, I try to always have a single line description, params with description and the return object.

I haven't started to build APIs used by external Devs, but yes, I need a lot to improve documentation skills too.

Apart from docstring, I do write wiki(during my personal free time) on how to use it and how to setup if someone wants to contribute.

To me it’s like this:

documentation is like sex

When it’s good you know it’s good

When it’s bad you just want to go somewhere and do it over by yourself.

@easyrhino You are pretty independent in that case. 😂

Unless it's Microsoft documentation, then I'd rather have nothing.