feat: allow using raw docstring for type docs #28
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
thbkrkr
reviewed
Jul 4, 2022
config/config.go
Outdated
| @@ -33,6 +33,7 @@ type ProcessorConfig struct { | |||
| IgnoreTypes []string `json:"ignoreTypes"` | |||
| IgnoreFields []string `json:"ignoreFields"` | |||
| IgnoreGroupVersions []string `json:"ignoreGroupVersions"` | |||
| TypeDocstringRaw bool `json:"typeDocstringRaw"` | |||
There was a problem hiding this comment.
Naming: maybe this is more explicit?
Suggested change
| TypeDocstringRaw bool `json:"typeDocstringRaw"` | |
| UseRawDocstring bool `json:"useRawDocstring"` |
processor/processor.go
Outdated
| @@ -265,6 +265,10 @@ func (p *processor) processType(pkg *loader.Package, info *markers.TypeInfo, dep | |||
| Doc: info.Doc, | |||
| } | |||
|
|
|||
| if p.typeDocstringRaw && info.RawDecl != nil { | |||
| typeDef.Doc = info.RawDecl.Doc.Text() | |||
There was a problem hiding this comment.
Could you add a comment?
Also, I see a new line added at the end, should we remove it?
Suggested change
| typeDef.Doc = info.RawDecl.Doc.Text() | |
| // use raw comments doc to support multi-line and indent preservation | |
| typeDef.Doc = strings.TrimSuffix(info.RawDecl.Doc.Text(), "\n") // remove trailing newline |
There was a problem hiding this comment.
commend add and newline trimmed 👍
logikone
force-pushed
the
type-docstring-raw
branch
2 times, most recently
from
7b7e9c0
to
c81a784
Compare
logikone
force-pushed
the
type-docstring-raw
branch
from
c81a784
to
3011fd5
Compare
|
@thbkrkr it would be great to have this released :) |
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.
closes #27