graphql-go / graphql-go/graphql

improve user-facing documentation

Open
#598 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
Go
Stars
10.1k
Forks
845
PR merge metrics
No merged PRs in 30d

Description

The Go Report Card for graphql-go/graphql shows a large number of exported symbols [without godoc comments](https://goreportcard.com/report/github.com/graphql-go/graphql#golint). Providing docs would certainly help user wanting to use the package.

Some of the smaller examples could also be moved into example tests given that pkg.go.dev renders them as main packages in the documentation. This would also ease uptake. If this is a desirable change, I can send a PR for this.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.