Skip to content

x/tools/gopls: in the go repo documentation for functions name issueXXXXX should include go.dev/issues link #76336

@Jorropo

Description

@Jorropo

See a function like this:

func issue57077(s []int) (left, right []int) {
	middle := len(s) / 2 // ERROR "Proved Div64 is unsigned$"
	left = s[:middle]    // ERROR "Proved IsSliceInBounds$"
	right = s[middle:]   // ERROR "Proved IsSliceInBounds$"
	return
}

As part of working on go I frequently need to open the issue related to this to find the relevant context.

However this function does not have any documentation that would include a link I could click, so I manually copy paste instead.

Image

I wished when looking up the documentation for this function would include a link to https://go.dev/issues/57077.

Other forms:

  • 43 func issue[0-9]+\(
  • 5 func Issue[0-9]+\(
  • 83 func Test[0-9]+\(
  • 276 func TestIssue[0-9]+\(
  • 1 func Benchmark[0-9]+\(
  • 6 func BenchmarkIssue[0-9]+\(

Metadata

Metadata

Assignees

No one assigned

    Labels

    DocumentationIssues describing a change to documentation.FeatureRequestIssues asking for a new feature that does not need a proposal.ToolsThis label describes issues relating to any tools in the x/tools repository.goplsIssues related to the Go language server, gopls.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions