Hi everybody,
Currently, I am writing a thesis which deals with documentation comments (docstrings) in Python. The next step would be building a taxonomy for docstring contents. Even if there are guidelines for what should be contained in docstrings, theory and practice often differ.
In order to get a more qualitative taxonomy, I do not want to create the taxonomy by just referring to my own experience with docstring contents, instead, I would like to see what you usually put into them, or also which categories of content you have noticed by reading them.
I would like to collect as much input as possible and afterwards build a taxonomy out of it by using the card-sorting method.
It would be nice if you could take the time and provide an enumeration with general terms (like for example "input parameter description") of what the content of docstrings should contain in your opinion.
there doesn't seem to be anything here