[pkgsite] internal/frontend: summarize package documentation

0 views

Skip to first unread message

Jonathan Amsterdam (Gerrit)

unread,

Jul 24, 2026, 1:54:39 PM (2 days ago) Jul 24

to goph...@pubsubhelper.golang.org, golang-...@googlegroups.com, Hyang-Ah Hana Kim, kokoro, golang...@luci-project-accounts.iam.gserviceaccount.com, Ethan Lee, golang-co...@googlegroups.com

Jonathan Amsterdam submitted the change

Change information

Commit message:

internal/frontend: summarize package documentation

The first of several CLs that implement a signal for documentation.
The idea is crude and simple: we will count the fraction of exported
symbols that have a doc comment, as well as consider whether the package
itself has a doc comment.

We divide the work into two parts: summarizing the package doc, and then
interpreting and displaying the summary. Most CLs will focus
on a summary.

This CL just sees whether there is a package doc.

For golang/go#80385.

Change-Id: I590de311b103f55053b989461ead11fbbb90f4a4

Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/805123

LUCI-TryBot-Result: golang...@luci-project-accounts.iam.gserviceaccount.com <golang...@luci-project-accounts.iam.gserviceaccount.com>

kokoro-CI: kokoro <noreply...@google.com>

Reviewed-by: Hyang-Ah Hana Kim <hya...@gmail.com>

Files:

M internal/frontend/evals.go
M internal/frontend/evals_test.go

Change size: M

Delta: 2 files changed, 146 insertions(+), 0 deletions(-)

Branch: refs/heads/master

Submit Requirements:

Code-Review: +2 by Hyang-Ah Hana Kim
TryBots-Pass: LUCI-TryBot-Result+1 by golang...@luci-project-accounts.iam.gserviceaccount.com
kokoro-CI-Passes: kokoro-CI+1 by kokoro

Open in Gerrit

Inspect html for hidden footers to help with email filtering. To unsubscribe visit settings.

Gerrit

open

diffy

satisfied_requirement

Reply all

Reply to author

Forward

0 new messages