diff options
| author | Tristan Van Berkom <tristan.vanberkom@codethink.co.uk> | 2020-04-20 16:35:53 +0900 |
|---|---|---|
| committer | bst-marge-bot <marge-bot@buildstream.build> | 2020-04-21 08:54:20 +0000 |
| commit | 668c9c00d84137cc4709ba50f485f3a54da58409 (patch) | |
| tree | 37a6d826f638b9c854c3623364451a242b2456a3 /src/buildstream/sandbox | |
| parent | fc39f81a2573b08f77391b21f38271858906a9ed (diff) | |
| download | buildstream-668c9c00d84137cc4709ba50f485f3a54da58409.tar.gz | |
src: Removing all pre 2.x "Since" documentation annotations.
This does not make sense to keep in the public API surface
documentation. As we are heading towards a release of 2.0, this
represents a "reset" in public API, and older annotations only
serve to clutter the documentation with information that is not
relevant to the reader.
Everything which is public at the time of the 2.0 release can
be considered available "Since: 2.0" implicitly (as this is
going to be the starting point of this new stable API).
It will make sense to start adding these annotations again for any
added API in 2.2 and forward.
Diffstat (limited to 'src/buildstream/sandbox')
| -rw-r--r-- | src/buildstream/sandbox/sandbox.py | 4 |
1 files changed, 1 insertions, 3 deletions
diff --git a/src/buildstream/sandbox/sandbox.py b/src/buildstream/sandbox/sandbox.py index 6f6acc946..bba051704 100644 --- a/src/buildstream/sandbox/sandbox.py +++ b/src/buildstream/sandbox/sandbox.py @@ -273,7 +273,7 @@ class Sandbox: cwd: The sandbox relative working directory in which to run the command. env: A dictionary of string key, value pairs to set as environment variables inside the sandbox environment. - label: An optional label for the command, used for logging. (*Since: 1.4*) + label: An optional label for the command, used for logging. Returns: The program exit code, or None if running in batch context. @@ -335,8 +335,6 @@ class Sandbox: Raises: (:class:`.SandboxCommandError`): If a command fails. - - *Since: 1.4* """ group = _SandboxBatchGroup(label=label) |