Switch to Google-Style docstrings #1227
MartinThoma
started this conversation in
Ideas
Replies: 1 comment
-
There is also the numpydoc style. I like it a lot, but in my experience many people think it's too verbose. |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Currently, our docstrings look like this:
I propose to use the Google docstring format instead:
There are two reasons why I suggest this change:
:param str title:
does not work,:param title:
would work)We can use both styles at the same time. Thus we don't need one gigantic PR to adjust the style, but we can make it e.g. module-by-module (and thus hopefully avoid merge conflicts).
What do you think?
Beta Was this translation helpful? Give feedback.
All reactions