consistent docstring format and language #1
Labels
documentation
missing or outdated documentation
good first issue
Good for newcomers
library
Concerns a library module or operator
The reference generated from docstrings in
lib/
needs a consistent format and language that helps to understand the individualop
s clearly. The following bits of information need to be covered in every description:The docstring format should support some kind of rich styling (possibly the markdown extension that is already used to generate other doc pages), so that parameter names, example code etc. can be highlighted properly.
The text was updated successfully, but these errors were encountered: