diff options
| author | Jonathan Amsterdam <jba@google.com> | 2026-03-27 15:18:20 -0400 |
|---|---|---|
| committer | Jonathan Amsterdam <jba@google.com> | 2026-04-06 07:29:20 -0700 |
| commit | f7258b211d2eab96a43600ece95d591f3973ae69 (patch) | |
| tree | 97f1c8d21108973533054f33a01f17e8d5d26269 /internal/api/testdata/markdown.golden | |
| parent | 2d0d60d0e456af02dfc52d79053d5a3a20fb11ff (diff) | |
| download | go-x-pkgsite-f7258b211d2eab96a43600ece95d591f3973ae69.tar.xz | |
internal/api: add support for examples
renderDoc now includes examples.
It has an option to omit examples, if we decide to omit them
in order to reduce the context load.
Change-Id: Ieaa411fe09b439f51aac7d49195cd5791a20d0d8
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/761000
LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com>
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
Reviewed-by: Ethan Lee <ethanalee@google.com>
TryBot-Bypass: Jonathan Amsterdam <jba@google.com>
Diffstat (limited to 'internal/api/testdata/markdown.golden')
| -rw-r--r-- | internal/api/testdata/markdown.golden | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/internal/api/testdata/markdown.golden b/internal/api/testdata/markdown.golden index 205546d0..8e19e5db 100644 --- a/internal/api/testdata/markdown.golden +++ b/internal/api/testdata/markdown.golden @@ -13,7 +13,7 @@ Search [Google](https://google.com) for details. ## Constants -``` +```go const ( X = 1 Y = 2 @@ -21,62 +21,62 @@ const ( ``` Several constants. -``` +```go const C = 1 ``` C is a shorthand for 1. ## Variables -``` +```go var V = 2 ``` V is a variable. ## Functions -``` +```go func Add(x int) int ``` Add adds 1 to x. -``` +```go func F() ``` F is a function. ## Types -``` +```go type A int ``` -``` +```go type B bool ``` -``` +```go type I1 interface { M1() } ``` I1 is an interface. -``` +```go type I2 interface { I1 M2() } ``` -``` +```go type S1 struct { F int // field } ``` S1 is a struct. -``` +```go type S2 struct { S1 G int @@ -84,22 +84,22 @@ type S2 struct { ``` S2 is another struct. -``` +```go type T int ``` T is a type. -``` +```go const CT T = 3 ``` CT is a typed constant. They appear after their type. -``` +```go func TF() T ``` TF is a constructor for T. -``` +```go func (T) M() ``` M is a method of T. BUG(xxx): this verifies that notes are rendered. |
