Skip to content
This repository has been archived by the owner on May 9, 2021. It is now read-only.

Exported Interface method docs should follow same rules as other exported identifiers #38

Closed
jimmyfrasche opened this issue Apr 22, 2014 · 1 comment

Comments

@jimmyfrasche
Copy link
Member

Given

type Interface interface {
    //I don't mention the name.
    F()
}

I would expect

comment on exported interface method  F should be of the form "F ..."

Currently no warning is emitted.

@dsymonds
Copy link
Contributor

That's not a style rule that is commonly followed, mainly because the comments aren't extracted by godoc. Same goes for struct fields.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants