You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Right now, docstrings have a syntax and layout that is quite variable, both in the code, and after rendering in the API.
It would be nice to homogenize all of that.
1/ For the code side, maybe we could have a linter that enforces a specific layout?
2/ For the rendering side, we could decide what we think is best (including references, details about default parameters in the function description or in the parameters, or both? etc), and then open a Wiki with guidelines to write the docstring of a function consistently in the first go.
I don't know what is the good practice, but I always remove the tab here, because in other places with different lengths (I believe e.g. when displaying the docstring from a Python console), the empty block shows up in the middle of a sentence...
Right now, docstrings have a syntax and layout that is quite variable, both in the code, and after rendering in the API.
It would be nice to homogenize all of that.
1/ For the code side, maybe we could have a linter that enforces a specific layout?
2/ For the rendering side, we could decide what we think is best (including references, details about default parameters in the function description or in the parameters, or both? etc), and then open a Wiki with guidelines to write the docstring of a function consistently in the first go.
Originally posted by @adehecq in #335 (comment)
The text was updated successfully, but these errors were encountered: