golang/go

cmd/gc: go:nointerface pragma is undocumented

Open

#33,737 opened on Aug 20, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Go (19,008 forks)batch import
DocumentationNeedsInvestigationhelp wanted

Repository metrics

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

Description

The Go compiler has a pragma

//go:nointerface

As far as I can tell, it prevents a method from being used to satisfy an interface. However, I cannot find any (public) documentation on it.

Even https://golang.org/src/cmd/compile/internal/gc/lex.go, which has comments for the other pragmas, does not describe this one.

Contributor guide

Research direction
Search the Go source code and official documentation for any existing references to the //go:nointerface pragma. Identify where it is used and propose adding a comment to lex.go or a doc.go file to document it.
Tech stack
go
Domain
compilers
Issue type
Documentation
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.
Under 1 hour
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
GitGo
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75