You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I feel its implied by the proposal that lists, because they can contain multiple paragraphs, should be able to contain links and doclinks. However, the current implementation of go/doc/comment does not support this, and treats lists as paragraphs of plain text.
This is how it would look with a list containing a doc link:
// - Do this, or...
// - Use [encoding/json.Marshal]
With a list containing a link:
// - Do this, or...
// - See [RFC]
//
// [RFC]: https://datatracker.ietf.org/doc/html/rfc2616
With a list containing a link, in a weird embedded link format, that also works (but perhaps shouldn't?)
// - Do this, or...
// - See [RFC], or...
//
// [RFC]: https://datatracker.ietf.org/doc/html/rfc2616
// - Something else
See pull request imminently
The text was updated successfully, but these errors were encountered:
The proposed (golang#51082) new go doc comment additions supports lists,
links, and doc links, but does not support links and doc links inside
lists, so implemnent this.
Fixesgolang#53610
Change-Id: I4fa17d204fc9efa8f3633133e4a49e56cf1aa9bc
Reviewed-on: https://go-review.googlesource.com/c/go/+/415174
Reviewed-by: Ben Golightly <golightly.ben@googlemail.com>
Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Reviewed-by: Ian Lance Taylor <iant@google.com>
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Ian Lance Taylor <iant@google.com>
Auto-Submit: Ian Lance Taylor <iant@google.com>
The proposed (#51082) new go doc comment additions supports lists, links, and doc links.
I feel its implied by the proposal that lists, because they can contain multiple paragraphs, should be able to contain links and doclinks. However, the current implementation of go/doc/comment does not support this, and treats lists as paragraphs of plain text.
This is how it would look with a list containing a doc link:
With a list containing a link:
With a list containing a link, in a weird embedded link format, that also works (but perhaps shouldn't?)
See pull request imminently
The text was updated successfully, but these errors were encountered: