golang/go

cmd/go: add go doc -json

Open

#34,293 opened on Sep 14, 2019

View on GitHub
 (20 comments) (9 reactions) (0 assignees)Go (19,008 forks)batch import
GoCommandNeedsFixProposalProposal-Acceptedhelp wanted

Repository metrics

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

Description

To build better language support for editors and ide's it could be helpful to have the docs as json.

For example https://golang.org/pkg/strings.json to get the strings package documentation. Or via terminal by a flag like go doc fmt -format json

Then the docs can be used to generate snippets based on the documentation.

Contributor guide

Research direction
Examine the existing `go/doc` package to understand documentation parsing and structure. Look at the `go doc` command implementation in `cmd/go/` to add a JSON output flag. Review issue comments for prior discussion.
Tech stack
go
Domain
cli
Issue type
Feature
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.
70