-
Notifications
You must be signed in to change notification settings - Fork 42
automation: add package docs #2416
Copy link
Copy link
Closed
Milestone
Description
The package documentation for cmd/automation currently looks like a stale copy of docs from cmd/librarian, and internal/automation doesn’t have any package docs at all.
See:
librarian/cmd/automation/main.go
Lines 15 to 18 in 0d0642d
// Librarian manages Google API client libraries by automating onboarding, // regeneration, and release. It runs language‑agnostic workflows while // delegating language‑specific tasks—such as code generation, building, and // testing—to Docker images. - https://pkg.go.dev/github.com/googleapis/librarian/cmd/automation
- https://pkg.go.dev/github.com/googleapis/librarian/internal/automation
We should update both to accurately describe what this tool is for and how it works. For reference, see the cmd/librarian documentation here: https://pkg.go.dev/github.com/googleapis/librarian/cmd/librarian.
See also https://go.dev/doc/comment how guidance on Go package docs.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels