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
Note: You can check the latest versions of the docs on masterhere.
Documentation problem
Features added to the code (new methods or parameters), should be accompanied by a "new in version ..." piece in the docstring.
The developer guide needs a section which asks developers to use this sphinx directive when contributing to code, and provide small docstring examples for method and parameter.
Location of the documentation
Added to bottom of https://www.staircase.dev/en/latest/development/guide/code.html
Note: You can check the latest versions of the docs on
master
here.Documentation problem
Features added to the code (new methods or parameters), should be accompanied by a "new in version ..." piece in the docstring.
The developer guide needs a section which asks developers to use this sphinx directive when contributing to code, and provide small docstring examples for method and parameter.
Suggested fix for documentation
These additions can be automatically generated by sphinx https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html?highlight=versionadded#directive-versionadded
See method example here https://github.com/pandas-dev/pandas/blob/v0.20.2/pandas/core/frame.py#L1495
See parameter example here https://github.com/pandas-dev/pandas/blob/v0.20.2/pandas/core/generic.py#L568
The text was updated successfully, but these errors were encountered: