Skip to content

cmd/doc: show Bugs section #33970

@pascaldekloe

Description

@pascaldekloe

The new go doc does not show documented bugs conform the convention.

For example, go doc -all godoc.org/pascaldekloe/jwt | grep -i bug has no results. The HTML representation catches the comments correctly at https://godoc.org/github.com/pascaldekloe/jwt#pkg-note-bug .

Bugs are an essential part of the documentation.

  • go doc -all should have a bugs section (like godoc(8) does)
  • go doc <selection> should include the relevant bugs for the respective selection

Metadata

Metadata

Assignees

No one assigned

    Labels

    FrozenDueToAgeNeedsFixThe path to resolution is known, but the work has not been done.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions