docs: Add versionadded directives for list builds and scans #3774
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
liuverta
commented
Apr 26, 2023
|
|
||
| .. versionadded:: 0.23.0 | ||
|
|
||
| """ |
| .. versionchanged:: 0.23.0 | ||
| Moved from ``verta.endpoint.Build`` to ``verta.endpoint.build.Build``. | ||
| .. versionadded:: 0.23.0 | ||
| The ``date_created`` property. |
There was a problem hiding this comment.
I would've put the date_created one with the actual property, but I don't like this blank space we end up rendering
| @@ -47,6 +51,8 @@ class ScanResultEnum(str, Enum): | |||
| class BuildScan: | |||
| """A scan of a Verta model build. | |||
|
|
|||
| .. versionadded:: 0.23.0 | |||
| @@ -29,6 +31,8 @@ class ScanProgressEnum(str, Enum): | |||
| class ScanResultEnum(str, Enum): | |||
| """The result of a build scan. | |||
|
|
|||
| .. versionadded:: 0.23.0 | |||
| @@ -10,6 +10,8 @@ | |||
| class ScanProgressEnum(str, Enum): | |||
| """The current progress of a build scan. | |||
|
|
|||
| .. versionadded:: 0.23.0 | |||
| @@ -1697,6 +1697,8 @@ def list_builds(self) -> List[Build]: | |||
| """ | |||
| Gets this model version's past and present builds. | |||
|
|
|||
| .. versionadded:: 0.23.0 | |||
hmacdonald-verta
approved these changes
Apr 26, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Impact and Context
For the changes from
Build.date_created#3756BuildScanclass #3757Build.get_scan()#3758Risks and Area of Effect
—
Testing
Built locally—see images in PR comments.
Reverting
Revert this PR.