-
Notifications
You must be signed in to change notification settings - Fork 0
Documenting new features and bug fixes
When adding a new feature or fixing a bug, it is much appreciated to document what you did with a compact reference in the release notes for that version, in doc/source/release.rst. Please reference the issue or pull request you can do it like so: :issue:`12345` where 12345 is the issue/pull request number. When adding a new feature or fixing a long-standing bug, it is good practice to let users know when this feature was added (or bug fixed).
The sphinx syntax for that is:
.. versionadded:: 0.13.0
Awesome documentation for awesome new feature!This will put the text New in version 0.13.0 wherever you put the Sphinx directive.
In addition, if the feature/improvement is noteworthy, please document it in the appropriate section in the whatsnew in a few lines or less in doc/source/vX.Y.Z.txt where X, Y, Z form the current development version of pandas.