manifest: document version errors in constructor

Manifest.__init__() can throw ManifestVersionError, but that's not
documented. Fix it.

Signed-off-by: Martí Bolívar <marti.bolivar@nordicsemi.no>
This commit is contained in:
Martí Bolívar 2019-11-11 10:48:18 -08:00 committed by Carles Cufí
parent ec312b100b
commit 8d3c318a0a
1 changed files with 9 additions and 0 deletions

View File

@ -100,6 +100,9 @@ class Manifest:
- `MalformedManifest` if *source_file* contains invalid
data
- `ManifestVersionError` if this version of west is too
old to parse the manifest.
- `MalformedConfig` if ``manifest.path`` is needed and
can't be read
@ -160,6 +163,9 @@ class Manifest:
Raises `MalformedManifest` if *source_data* is not a valid
manifest.
Raises `ManifestVersionError` if this version of west is too
old to parse the manifest.
:param source_data: parsed YAML data as a Python object, or a
string with unparsed YAML data
:param manifest_path: fallback `ManifestProject` path
@ -208,6 +214,9 @@ class Manifest:
- `MalformedManifest`: if the manifest data is invalid
- `ManifestVersionError`: if this version of west is too
old to parse the manifest
- `WestNotFound`: if *topdir* was needed and not found
- ``ValueError``: for other invalid arguments