From a510f35c4a7e26511bf16be273da5d099b355b4d Mon Sep 17 00:00:00 2001 From: Tristan Van Berkom Date: Mon, 20 Apr 2020 16:39:30 +0900 Subject: doc/source/hacking/coding_guidelines.rst: Adjusting "Since" guidelines. The guidelines are already correct, however they use 1.x as the reference for this API. This commit simply changes the guidelines to indicate 2.x to contributors as the latest major point release to care about. --- doc/source/hacking/coding_guidelines.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/source/hacking/coding_guidelines.rst b/doc/source/hacking/coding_guidelines.rst index ecab2410f..bdc568c9d 100644 --- a/doc/source/hacking/coding_guidelines.rst +++ b/doc/source/hacking/coding_guidelines.rst @@ -39,7 +39,7 @@ When documenting the public API surface which is rendered in the reference manual, we always mention the major version in which the API was introduced, as shown in the examples below. If a public API exists without the *Since* annotation, this is taken to mean that it was available since the first stable -release 1.0. +major point release (e.g: 2.0). Here are some examples to get the hang of the format of API documenting comments and docstrings. @@ -57,7 +57,7 @@ comments and docstrings. Returns: (Element): The frobnicated version of this Element. - *Since: 1.2* + *Since: 2.2* """ ... @@ -85,7 +85,7 @@ comments and docstrings. self.name = self._compute_name(context, element) """The name of this foo - *Since: 1.2* + *Since: 2.2* """ .. note:: @@ -121,7 +121,7 @@ comments and docstrings. context (Context): The invocation Context count (int): The number to count - *Since: 1.2* + *Since: 2.2* """ ... -- cgit v1.2.1