Adding comments on Kanister Resource Types Fields in types.go #1751
Conversation
There were comments missing from kanister resource types fields in types.go which because of which the documentation was not coming out to be proper. So, added missing comments on types.go Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
There was a problem hiding this comment.
@Kartik-Garg Please go through https://docs.kanister.io/architecture.html to understand the significance of each field and correct the comments. I went through few but will re-review once you correct the field comments by referring the doc
@PrasadG193 I see, I did not realize we could write comments by referring to https://docs.kanister.io/architecture.html |
Made some modifications in the comments under types.go by refering to https://docs.kanister.io/architecture.html#profiles Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
Added 'Represents' prefix on comment
Added new comments and modified few existing comments for better understanding. Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
Added new comments and modified existing comments for better understanding. Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
…k-Garg/kanister into commentsOnKanisterResource Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
Added new comments and modified few existing comments present in types.go for better understanding. Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
|
@Kartik-Garg have you addressed all the review comment's suggestion in this PR? If yes, can you please mark the comments resolved. |
@viveksinghggits There's just one comment left about |
Modified few comments present in the types.go file so it would be easier to understand the fields. Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
Made modification on the comments in the types.go file Signed-off-by: Kartik-Garg <kartikgarg938@gmail.com>
Thanks a lot for the reviews, made changes according to the review comments, eagerly waiting for upcoming parts :D |
modifying the grammar to make it better Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modified the comments in types.go to make it more understanding. Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
modifying the comment present for profile Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
updating comments Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modified the comment present on the Bucket Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying the comment present for Prefix Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying the comment present on Region Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying for Types comment Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying comments present on the KeyPair Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
modified comments present on the username Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying comments present on the hostname Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
modifying the comments present on Key field Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying the comment present on the Secret field Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying the comments present on Items Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
modifying comment present on the IDField Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
Modifying comment present on the field SecretField Co-authored-by: Pavan Navarathna <6504783+pavannd1@users.noreply.github.com>
|
@pavannd1 Thanks for the review comments, I have made the commits according to the suggestion. :D |
|
@pavannd1 I just updated the branch with respect to upstream, if everything is in order, could you please merge the PR |
There were comments missing from kanister resource types fields in types.go ,because of which there was missing description while creating the documentation using tools like https://github.com/ahmetb/gen-crd-api-reference-docs/ . So, added missing comments on fields present in types.go
Signed-off-by: Kartik-Garg kartikgarg938@gmail.com
Change Overview
The documentation generated now has description of all the fields present in Types.go:
Added missing comments on fields on types.go file.
Pull request type
Please check the type of change your PR introduces:
Issues
Test Plan