> For the complete documentation index, see [llms.txt](https://lwang010.gitbook.io/longw/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://lwang010.gitbook.io/longw/mlops/chap-4.-build-toolkit-for-team-or-yourself/tips/docstring.md).

# docstring

include a docstring in the beginning of a file/module, indicating the purpose of a file, under every class declaration and inside every function.

**The first line always indicates what the code does** and it is the only real essential part (I personally try to always include this in my code). The other parts explain what arguments the function accepts (with types and descriptions) and what it returns.