Support new godoc spec enforced by gofmt #82
Closed
+184
−160
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
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 16, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 16, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
phsym
force-pushed
the
new_godoc_spec
branch
from
e9b2352
to
01a1de8
Compare
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 19, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
Make use of go/doc and go/doc/comment std packages to parse and ender godoc paragraph
phsym
force-pushed
the
new_godoc_spec
branch
from
01a1de8
to
aa089f4
Compare
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 19, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
phsym
force-pushed
the
new_godoc_spec
branch
from
9a3fc53
to
7d0517e
Compare
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 21, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
phsym
force-pushed
the
new_godoc_spec
branch
from
762bc79
to
5937c86
Compare
phsym
added a commit
to phsym/gomarkdoc
that referenced
this pull request
Dec 24, 2022
This is temporary so that we can go run from this repo waiting for the PR princjef#82 to be reviewed and merge
|
@phsym thanks for the PR! This is a big update that clearly took some time to put together. I unfortunately already had most of the implementation put together in a separate change which I ended up using for the final version of the go 1.19 support, so I won't be able to merge this as is. It looks like you may have some specific functionality (such as the GOPRIVATE support) which I didn't implement in my version. If you're interested in trying to port that and other relevant logic over I'd happily work with you to get it merged, though I understand it's been a while and you may not have the time/inclination at this point. Let me know your thoughts. |
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.
Hi ! Thanks for this awesome tool.
As stated in #81 unfortunately, it does not play well with the new godoc spec. Like headers, or links references.
This PR is an attempt to delegate the parsing of docstrings to
go/doc/comment.Parser, and markdown rendering (escaping) togo/doc/comment.Printeras suggested in a comment of #81I may have missed things but from the tests I did on a large codebase, it seems to be working quite well.
I also updated to go 1.19
You can give it a try with
Fixes #81