fix(pacmak): go docs overview displays repeating description #4081
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
RomainMuller
reviewed
May 5, 2023
Comment on lines
472
to
478
| protected emitHeader(code: CodeMaker) { | ||
| if (this.assembly.description !== '') { | ||
| code.line(`// ${this.assembly.description}`); | ||
| } | ||
| code.line(`package ${this.packageName}`); | ||
| code.line(); | ||
| } |
There was a problem hiding this comment.
I think this should still be emitted.... but only in a single file (for example, main.go) so it's not more-than-duplicated...
I think this also has value in IDE integrations, etc... the docsite experience isn't the only place where this might show.
There was a problem hiding this comment.
I see, will make the update. Thank you.
vinayak-kukreja
force-pushed
the
vkukreja/fix-go-docs
branch
from
ad707c6
to
1ccf8f3
Compare
Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>
Signed-off-by: Vinayak Kukreja <vinakuk@amazon.com>
RomainMuller
approved these changes
May 9, 2023
|
Thank you for contributing! ❤️ I will now look into making sure the PR is up-to-date, then proceed to try and merge it! |
|
Merging (with squash)... |
|
Merging (with squash)... |
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.
Our
go docshave been broken since jsiiv1.65.0. This was due to moving to emitting one file per type and headers being added to all those files: Impacting PRThe first occurrence was in docs for cdk v2.39.0 and is still present in the latest version.
The header being added is
Version 2 of the AWS Cloud Development Kit libraryto multiple files. It's determining this value from the package.json file ofaws-cdk-lib. I see adding this is most relevant for maven, hence removing it fromgosince I do not believe it's bringing much value to our documentation. Let me know if you feel otherwise :)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.