-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
go/doc/comment: support links in lists in comments
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. Fixes golang#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>
- Loading branch information
1 parent
3e3bf4d
commit f9dacf6
Showing
5 changed files
with
131 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
{"DocLinkBaseURL": "https://pkg.go.dev"} | ||
-- input -- | ||
Did you know? | ||
|
||
- [encoding/json.Marshal] is a doc link. So is [encoding/json.Unmarshal]. | ||
-- text -- | ||
Did you know? | ||
|
||
- encoding/json.Marshal is a doc link. So is encoding/json.Unmarshal. | ||
-- markdown -- | ||
Did you know? | ||
|
||
- [encoding/json.Marshal](https://pkg.go.dev/encoding/json#Marshal) is a doc link. So is [encoding/json.Unmarshal](https://pkg.go.dev/encoding/json#Unmarshal). | ||
-- html -- | ||
<p>Did you know? | ||
<ul> | ||
<li><a href="https://pkg.go.dev/encoding/json#Marshal">encoding/json.Marshal</a> is a doc link. So is <a href="https://pkg.go.dev/encoding/json#Unmarshal">encoding/json.Unmarshal</a>. | ||
</ul> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
{"DocLinkBaseURL": "https://pkg.go.dev"} | ||
-- input -- | ||
Did you know? | ||
|
||
- [testing.T] is one doc link. | ||
- So is [testing.M]. | ||
- So is [testing.B]. | ||
This is the same list paragraph. | ||
|
||
There is [testing.PB] in this list item, too! | ||
-- text -- | ||
Did you know? | ||
|
||
- testing.T is one doc link. | ||
|
||
- So is testing.M. | ||
|
||
- So is testing.B. This is the same list paragraph. | ||
|
||
There is testing.PB in this list item, too! | ||
-- markdown -- | ||
Did you know? | ||
|
||
- [testing.T](https://pkg.go.dev/testing#T) is one doc link. | ||
|
||
- So is [testing.M](https://pkg.go.dev/testing#M). | ||
|
||
- So is [testing.B](https://pkg.go.dev/testing#B). This is the same list paragraph. | ||
|
||
There is [testing.PB](https://pkg.go.dev/testing#PB) in this list item, too! | ||
-- html -- | ||
<p>Did you know? | ||
<ul> | ||
<li><p><a href="https://pkg.go.dev/testing#T">testing.T</a> is one doc link. | ||
<li><p>So is <a href="https://pkg.go.dev/testing#M">testing.M</a>. | ||
<li><p>So is <a href="https://pkg.go.dev/testing#B">testing.B</a>. | ||
This is the same list paragraph. | ||
<p>There is <a href="https://pkg.go.dev/testing#PB">testing.PB</a> in this list item, too! | ||
</ul> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
{"DocLinkBaseURL": "https://pkg.go.dev"} | ||
-- input -- | ||
Cool things: | ||
|
||
- Foo | ||
- [Go] | ||
- Bar | ||
|
||
[Go]: https://go.dev/ | ||
-- text -- | ||
Cool things: | ||
|
||
- Foo | ||
- Go | ||
- Bar | ||
|
||
[Go]: https://go.dev/ | ||
-- markdown -- | ||
Cool things: | ||
|
||
- Foo | ||
- [Go](https://go.dev/) | ||
- Bar | ||
|
||
-- html -- | ||
<p>Cool things: | ||
<ul> | ||
<li>Foo | ||
<li><a href="https://go.dev/">Go</a> | ||
<li>Bar | ||
</ul> |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
{"DocLinkBaseURL": "https://pkg.go.dev"} | ||
-- input -- | ||
Cool things: | ||
|
||
- Foo | ||
- [Go] is great | ||
|
||
[Go]: https://go.dev/ | ||
- Bar | ||
|
||
-- text -- | ||
Cool things: | ||
|
||
- Foo | ||
|
||
- Go is great | ||
|
||
- Bar | ||
|
||
[Go]: https://go.dev/ | ||
-- markdown -- | ||
Cool things: | ||
|
||
- Foo | ||
|
||
- [Go](https://go.dev/) is great | ||
|
||
- Bar | ||
|
||
-- html -- | ||
<p>Cool things: | ||
<ul> | ||
<li><p>Foo | ||
<li><p><a href="https://go.dev/">Go</a> is great | ||
<li><p>Bar | ||
</ul> |