Document fields in spec to indicate when these were added. #215
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
bart0sh
force-pushed
the
PR018-document-spec-fields
branch
from
e4b20f8 to
1e5f869
Compare
Signed-off-by: Ed Bartosh <[email protected]>
bart0sh
force-pushed
the
PR018-document-spec-fields
branch
from
1e5f869 to
61fe2c4
Compare
klihub
approved these changes
Jul 29, 2024
elezar
reviewed
Aug 6, 2024
I'd leave it as it is. "Added in v.6.0" sounds more informative to me. |
Signed-off-by: Ed Bartosh <[email protected]>
bart0sh
force-pushed
the
PR018-document-spec-fields
branch
from
ca319de to
9c4f75c
Compare
elezar
reviewed
Aug 8, 2024
| @@ -19,6 +20,7 @@ type Spec struct { | |||
| type Device struct { | |||
| Name string `json:"name"` | |||
| // Annotations add meta information per device. Note these are CDI-specific and do not affect container metadata. | |||
| // Added in v0.6.0. | |||
There was a problem hiding this comment.
One thought that I had was whether we wanted to add golang field tags so that we could parse these programatically? This could be done as a follow-up though.
elezar
reviewed
Aug 8, 2024
| @@ -10,6 +10,7 @@ type Spec struct { | |||
| Version string `json:"cdiVersion"` | |||
| Kind string `json:"kind"` | |||
There was a problem hiding this comment.
Do we want to call out the allowed character change for the class in a docstring?
elezar
approved these changes
Aug 8, 2024
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.
partial fix for #206