summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTristan Van Berkom <tristan.vanberkom@codethink.co.uk>2020-04-20 16:39:30 +0900
committerbst-marge-bot <marge-bot@buildstream.build>2020-04-21 08:54:20 +0000
commit1a2a7905fb69bd4d36c65e2a5bd74aecae7c87f9 (patch)
tree081b418ddb7f7159fc273deb1a5b7667dc4749f4
parent668c9c00d84137cc4709ba50f485f3a54da58409 (diff)
downloadbuildstream-1a2a7905fb69bd4d36c65e2a5bd74aecae7c87f9.tar.gz
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.
-rw-r--r--doc/source/hacking/coding_guidelines.rst8
1 files 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*
"""
...