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
For docstrings that have quite some examples, it might be useful to provide some more structure in there.
The numpydoc parsing does not really allow actual sections, but by using for example a bold font, you can create a bit the 'sense' of subsections.
Is this something we would want to encourage in the docstring guide?
Example of the current examples section of to_datetime:
And one with 'subsections' (just for the idea, not necessarily perfect titles :)):
For docstrings that have quite some examples, it might be useful to provide some more structure in there.
The numpydoc parsing does not really allow actual sections, but by using for example a bold font, you can create a bit the 'sense' of subsections.
Is this something we would want to encourage in the docstring guide?
Example of the current examples section of
to_datetime
:And one with 'subsections' (just for the idea, not necessarily perfect titles :)):
cc @datapythonista @jreback @TomAugspurger
The text was updated successfully, but these errors were encountered: