/ swag Public
fix: fmt issue with struct #1248
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.
Fix issue #1150
To summarize the issue, running
swag fmtwill set (at least) 2 spaces between the attribute tag and the rest of the comment. But this is a problem for struct with single comment:
Indeed the doc generation doesn't interpret this correctly for struct (it completely ignore it).
So there are 2 solutions:
This commit is fixing the indent part.
Basically I just set the padding=1 on
The cons is that it will also impacts all other godocs.
For instance (taken from the readme):
I don't know if there was a reason for the choice of padding=2 apart aesthetic.
Ping @HYY-yu who first use it in commit 93acd2ad