docs: better guidance on how to write docstrings

[lars-reimann]

Closes #191.

Summary of Changes

Improve guidelines how to write good docstrings.

[lars-reimann]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ MARKDOWN	markdown-link-check	1		0	1.29s
✅ REPOSITORY	git_diff	yes		no	0.03s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[codecov]

Codecov Report

Merging #226 (716648c) into main (a4cf0a5) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #226   +/-   ##
=======================================
  Coverage   96.42%   96.42%           
=======================================
  Files          42       42           
  Lines        1482     1482           
=======================================
  Hits         1429     1429           
  Misses         53       53           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[lars-reimann]

🎉 This PR is included in version 0.12.0 🎉

The release is available on:

• v0.12.0
• GitHub release

Your semantic-release bot 📦🚀