Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: Create "version added" documentation instructions to developer guide #81

Open
venaturum opened this issue Sep 11, 2021 · 3 comments
Labels
beginner difficulty level documentation Improvements or additions to documentation high priority

Comments

@venaturum
Copy link
Collaborator

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

@venaturum venaturum added beginner difficulty level documentation Improvements or additions to documentation high priority labels Sep 11, 2021
@gourcool
Copy link

Can you assign this issue to me

@venaturum
Copy link
Collaborator Author

@gourcool, sure thing. I think if you leave the comment "take" it will automatically assign it to you too.

@venaturum
Copy link
Collaborator Author

let me know if you need a hand or guidance at any stage

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
beginner difficulty level documentation Improvements or additions to documentation high priority
Projects
None yet
Development

No branches or pull requests

2 participants