golang/go

x/tools/gopls: improve output for subcommands with no flags

Open

#43,447 opened on Dec 31, 2020

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
Toolsgoplshelp wanted

Repository metrics

Stars
 (133,883 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Currently (golang/tools@63754364767c), the output of gopls check -h looks like this:

show diagnostic results for the specified file

Usage: check [flags] <filename>

Example: show the diagnostic results of this file:

  $ gopls check internal/lsp/cmd/check.go

	gopls check flags are:

That is, no flags are documented. If gopls check actually has flags, they should probably be documented, and if not, the output should probably not mention them at all.

Contributor guide

Research direction
Locate the help text generation code for gopls subcommands and adjust it to omit the flags section when no flags are defined.
Tech stack
go
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Go
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80