From cd7184e71fc4455d3412245463838a8b12d56123 Mon Sep 17 00:00:00 2001 From: Ralf Gommers Date: Sat, 14 Apr 2012 10:44:07 +0200 Subject: [PATCH] DOC: add explanation about version number to use with versionadded directive. --- doc/HOWTO_CONTRIBUTE.rst.txt | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/HOWTO_CONTRIBUTE.rst.txt b/doc/HOWTO_CONTRIBUTE.rst.txt index 29d3326cc9af..c86745d56741 100644 --- a/doc/HOWTO_CONTRIBUTE.rst.txt +++ b/doc/HOWTO_CONTRIBUTE.rst.txt @@ -159,8 +159,10 @@ Checklist before submitting a PR - Are there unit tests with good code coverage? - Do all public function have docstrings including examples? - Is the code style correct (PEP8, pyflakes) - - Is the new functionality tagged with ``.. versionadded:: X.Y.Z``? - - Is the new functionality mentioned in the release notes of the next release? + - Is the new functionality tagged with ``.. versionadded:: X.Y.Z`` (with + X.Y.Z the version number of the next release - can be found in setup.py)? + - Is the new functionality mentioned in the release notes of the next + release? - Is the new functionality added to the reference guide? - In case of larger additions, is there a tutorial or more extensive module-level description?