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/api.go | |
| 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/api.go')
| -rw-r--r-- | internal/api/api.go | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/internal/api/api.go b/internal/api/api.go index 867d1d1d..cf771e82 100644 --- a/internal/api/api.go +++ b/internal/api/api.go @@ -112,7 +112,9 @@ func ServePackage(w http.ResponseWriter, r *http.Request, ds internal.DataSource default: return fmt.Errorf("%w: bad doc format: need one of 'text', 'md', 'markdown' or 'html'", derrors.InvalidArgument) } - if err := renderDoc(dpkg, r); err != nil { + // TODO(jba): add a param to omit examples + const includeExamples = true + if err := renderDoc(dpkg, r, includeExamples); err != nil { return fmt.Errorf("%w: %s", derrors.Unknown, err.Error()) } docs = sb.String() |