Skip to content

Commit

Permalink
docs: Add versionadded directives for list builds and scans (#3774)
Browse files Browse the repository at this point in the history
  • Loading branch information
liuverta committed Apr 26, 2023
1 parent aa2ca2b commit 30de8a3
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 1 deletion.
6 changes: 5 additions & 1 deletion client/verta/verta/endpoint/build/__init__.py
@@ -1,6 +1,10 @@
# -*- coding: utf-8 -*-

"""Verta model builds."""
"""Verta model builds.
.. versionadded:: 0.23.0
"""

from verta._internal_utils import documentation

Expand Down
7 changes: 7 additions & 0 deletions client/verta/verta/endpoint/build/_build.py
Expand Up @@ -11,6 +11,11 @@ class Build:
"""
An initiated docker build process of a deployable model.
.. versionchanged:: 0.23.0
Moved from ``verta.endpoint.Build`` to ``verta.endpoint.build.Build``.
.. versionadded:: 0.23.0
The ``date_created`` property.
Represents an initiated docker build process. A build can be complete or in
progress. Completed builds may be successful or failed. End-users of this
library should not need to instantiate this class directly, but instead
Expand Down Expand Up @@ -95,6 +100,8 @@ def is_complete(self) -> bool:
def get_scan(self) -> _build_scan.BuildScan:
"""Get this build's most recent scan.
.. versionadded:: 0.23.0
Returns
-------
:class:`~verta.endpoint.build.BuildScan`
Expand Down
6 changes: 6 additions & 0 deletions client/verta/verta/endpoint/build/_build_scan.py
Expand Up @@ -10,6 +10,8 @@
class ScanProgressEnum(str, Enum):
"""The current progress of a build scan.
.. versionadded:: 0.23.0
For all intents and purposes, this can be treated as a :class:`str`.
Examples
Expand All @@ -29,6 +31,8 @@ class ScanProgressEnum(str, Enum):
class ScanResultEnum(str, Enum):
"""The result of a build scan.
.. versionadded:: 0.23.0
For all intents and purposes, this can be treated as a :class:`str`.
Examples
Expand All @@ -47,6 +51,8 @@ class ScanResultEnum(str, Enum):
class BuildScan:
"""A scan of a Verta model build.
.. versionadded:: 0.23.0
There should not be a need to instantiate this class directly; please use
:meth:`Build.get_scan() <verta.endpoint.build.Build.get_scan>` instead.
Expand Down
2 changes: 2 additions & 0 deletions client/verta/verta/registry/entities/_modelversion.py
Expand Up @@ -1697,6 +1697,8 @@ def list_builds(self) -> List[Build]:
"""
Gets this model version's past and present builds.
.. versionadded:: 0.23.0
Builds are returned in order of creation (most recent first).
Returns
Expand Down

0 comments on commit 30de8a3

Please sign in to comment.