-
Notifications
You must be signed in to change notification settings - Fork 212
Create separate documentation.yaml
file
#447
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
great stuff here @RedbackThomson! really appreciate this. Couple smallish nits inline but overall awesome.
pkg/config/documentation.go
Outdated
Append *string `json:"append,omitempty"` | ||
Prepend *string `json:"prepend,omitempty"` | ||
Override *string `json:"override,omitempty"` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please add docstrings for these fields
// slashes to the beginning of each new line | ||
lines := strings.Split(in, "\n") | ||
|
||
// Traverse in reverse order until, deleting empty lines |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Any reason you wanted to delete empty newlines? Sometimes a long docstring is better broken into paragraphs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Only deleting trailing newlines here
@RedbackThomson also, see unit test output failure:
|
/retest |
Nice, ty @RedbackThomson ! |
This will require a follow up with the RDS controller to move their stuff over. Reminder to me to do that |
/lgtm |
1 similar comment
/lgtm |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: A-Hilaly, RedbackThomson The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
/retest |
Closes aws-controllers-k8s/community#1223
Expands upon #394
Description of changes:
This pull request moves the custom GoDoc overrides from inside the
generator.yaml
file to a new, separatedocumentation.yaml
file. Thisdocumentation.yaml
file currently supports modify field GoDocs (but could be extended to modify resource GoDocs as well) in the following ways:The current RDS documentation modifications are now modeled in the
documentation.yaml
like so:By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.