fix: fmt issue with struct #1248
Merged
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
To summarize the issue, running `swag fmt` will 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:
```diff
type Example struct {
Foobar string
-} // @name Example
+} // @name Example
```
Indeed the doc generation doesn't interpret this correctly for struct (it completely ignore it).
So there are 2 solutions:
- fix the indent (which is feel more natural)
- fix the doc generation to correctly parse 2 spaces
This commit is fixing the indent part.
Basically I just set the padding=1 on `tabwriter`.
The cons is that it will also impacts all other godocs.
For instance (taken from the readme):
```diff
-// @title Swagger Example API
-// @Version 1.0
-// @description This is a sample server celler server.
-// @termsofservice http://swagger.io/terms/
+// @title Swagger Example API
+// @Version 1.0
+// @description This is a sample server celler server.
+// @termsofservice http://swagger.io/terms/
```
MattKetmo
force-pushed
the
fix-fmt-padding
branch
from
31cbc21
to
1524e3a
Compare
Codecov Report
@@ Coverage Diff @@
## master #1248 +/- ##
=======================================
Coverage 94.98% 94.99%
=======================================
Files 14 14
Lines 2614 2618 +4
=======================================
+ Hits 2483 2487 +4
Misses 72 72
Partials 59 59
Continue to review full report at Codecov.
|
|
@MattKetmo Thanks for your contribution. |
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.
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:type Example struct { Foobar string -} // @name Example +} // @name ExampleIndeed 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
tabwriter.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