From 7102b99653e354eb8c291cfa5b4f772d15d83ae0 Mon Sep 17 00:00:00 2001 From: Tim Graham Date: Fri, 9 Jan 2015 12:52:54 -0500 Subject: Added best practices for versionadded/changed annotations. --- docs/internals/contributing/writing-code/submitting-patches.txt | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/internals/contributing/writing-code') diff --git a/docs/internals/contributing/writing-code/submitting-patches.txt b/docs/internals/contributing/writing-code/submitting-patches.txt index 7bc37f5a75..965ce45eaa 100644 --- a/docs/internals/contributing/writing-code/submitting-patches.txt +++ b/docs/internals/contributing/writing-code/submitting-patches.txt @@ -320,7 +320,8 @@ New Features * Are there tests to "exercise" all of the new code? * Is there a release note in ``docs/releases/A.B.txt``? -* Is there documentation for the feature and is it annotated appropriately with +* Is there documentation for the feature and is it :ref:`annotated + appropriately ` with ``.. versionadded:: A.B`` or ``.. versionchanged:: A.B``? Deprecating a feature -- cgit v1.3