Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

x/tools/gopls: analyzer docs mishandle section headings #75199

Open
Labels
DocumentationIssues describing a change to documentation. goplsIssues related to the Go language server, gopls. gopls/analysisIssues related to running analysis in gopls
Milestone
@adonovan

Description

The docs at https://go.dev/gopls/analyzers are generated from the documentation for each individual analyzer. However, the combined doc turns primary headings into secondary headings, causing confusion. Notice that the table of contents includes these three items in sequence, even though Functions and Constants should be subordinate to gofix and should not appear in the ToC:

We need to alter the generator script and/or clarify the policy on usage of headings in analyzer docs.

cc: @jba

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues describing a change to documentation. goplsIssues related to the Go language server, gopls. gopls/analysisIssues related to running analysis in gopls

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions

      AltStyle によって変換されたページ (->オリジナル) /