Documentation Linting is Ignored

[Samyoul]

trafficstars

Problem

The current automated linting seems to be ignore documentation based lint checks.

By entering the following commands:

cd waku
golint ./...

You get the following lint report:

config.go:36:5: exported var DefaultConfig should have comment or be unexported
waku.go:54:6: exported type Bridge should have comment or be unexported
waku.go:397:1: comment on exported method Waku.RateLimits should be of the form "RateLimits ..."
waku.go:448:1: comment on exported method Waku.RegisterRateLimiter should be of the form "RegisterRateLimiter ..."
waku.go:496:1: exported method Waku.SendEnvelopeEvent should have comment or be unexported
waku.go:615:1: exported method Waku.SendMessagesRequest should have comment or be unexported
waku.go:650:1: exported method Waku.SendHistoricMessageResponse should have comment or be unexported
waku.go:658:1: comment on exported method Waku.SendP2PMessages should be of the form "SendP2PMessages ..."
waku.go:1059:1: exported method Waku.OnNewEnvelopes should have comment or be unexported
waku.go:1090:1: exported method Waku.OnNewP2PEnvelopes should have comment or be unexported
waku.go:1097:1: exported method Waku.Mailserver should have comment or be unexported
waku.go:1101:1: exported method Waku.OnMessagesRequest should have comment or be unexported
waku.go:1106:1: exported method Waku.OnP2PRequestCompleted should have comment or be unexported
waku.go:1116:1: exported method Waku.OnMessagesResponse should have comment or be unexported
waku.go:1127:1: exported method Waku.OnBatchAcknowledged should have comment or be unexported
waku.go:1189:1: exported method Waku.SetBloomFilterMode should have comment or be unexported
waku.go:1418:1: comment on exported method Waku.IsEnvelopeCached should be of the form "IsEnvelopeCached ..."
common\bloomfilter.go:3:1: exported function IsFullNode should have comment or be unexported
common\bloomfilter.go:15:1: exported function BloomFilterMatch should have comment or be unexported
common\bloomfilter.go:31:1: exported function MakeFullNodeBloom should have comment or be unexported
common\envelope.go:132:1: exported method Envelope.CalculatePoW should have comment or be unexported
common\message.go:110:1: exported method MessagesRequest.Validate should have comment or be unexported
common\message.go:138:1: exported function IsMessageSigned should have comment or be unexported
common\message.go:151:45: exported func NewSentMessage returns unexported type *common.sentMessage, which can be annoying to use
common\metrics.go:26:2: exported var EnvelopesReceivedCounter should have comment or be unexported
common\rate_limiter.go:44:6: exported type RateLimiterHandler should have comment or be unexported
common\rate_limiter.go:49:6: exported type MetricsRateLimiterHandler should have comment or be unexported
common\rate_limiter.go:51:1: exported method MetricsRateLimiterHandler.ExceedPeerLimit should have comment or be unexported
common\rate_limiter.go:55:1: exported method MetricsRateLimiterHandler.ExceedIPLimit should have comment or be unexported
common\rate_limiter.go:68:1: exported method RateLimits.IsZero should have comment or be unexported
common\rate_limiter.go:73:6: exported type DropPeerRateLimiterHandler should have comment or be unexported
common\rate_limiter.go:82:1: exported method DropPeerRateLimiterHandler.ExceedPeerLimit should have comment or be unexported
common\rate_limiter.go:90:1: exported method DropPeerRateLimiterHandler.ExceedIPLimit should have comment or be unexported
common\rate_limiter.go:127:1: exported function NewPeerRateLimiter should have comment or be unexported
common\rate_limiter.go:144:1: exported method PeerRateLimiter.Decorate should have comment or be unexported
v0\peer.go:59:1: exported function NewPeer should have comment or be unexported
v0\peer.go:78:1: exported method Peer.Start should have comment or be unexported
v0\peer.go:87:1: exported method Peer.Stop should have comment or be unexported
v0\peer.go:92:1: exported method Peer.NotifyAboutPowRequirementChange should have comment or be unexported
v0\peer.go:97:1: exported method Peer.NotifyAboutBloomFilterChange should have comment or be unexported
v0\peer.go:101:1: exported method Peer.NotifyAboutTopicInterestChange should have comment or be unexported
v0\peer.go:105:1: exported method Peer.SetPeerTrusted should have comment or be unexported
v0\peer.go:109:1: exported method Peer.RequestHistoricMessages should have comment or be unexported
v0\peer.go:113:1: exported method Peer.SendMessagesRequest should have comment or be unexported
v0\peer.go:117:1: exported method Peer.SendHistoricMessageResponse should have comment or be unexported
v0\peer.go:127:1: exported method Peer.SendP2PMessages should have comment or be unexported
v0\peer.go:131:1: exported method Peer.SendRawP2PDirect should have comment or be unexported
v0\peer.go:135:1: exported method Peer.SetRWWriter should have comment or be unexported
v0\peer.go:149:1: exported method Peer.BloomFilter should have comment or be unexported
v0\peer.go:158:1: exported method Peer.PoWRequirement should have comment or be unexported
v0\peer.go:162:1: exported method Peer.ConfirmationsEnabled should have comment or be unexported
v0\peer.go:172:1: exported method Peer.EnodeID should have comment or be unexported
v0\peer.go:176:1: exported method Peer.IP should have comment or be unexported
v0\peer.go:180:1: exported method Peer.Run should have comment or be unexported
v0\status_options.go:40:1: exported function StatusOptionsFromHost should have comment or be unexported
v0\status_options.go:123:1: exported method StatusOptions.PoWRequirementF should have comment or be unexported
v0\status_options.go:131:1: exported method StatusOptions.SetPoWRequirementFromF should have comment or be unexported
v0\status_options.go:136:1: exported method StatusOptions.EncodeRLP should have comment or be unexported
v0\status_options.go:155:1: exported method StatusOptions.DecodeRLP should have comment or be unexported
v0\status_options.go:202:1: exported method StatusOptions.Validate should have comment or be unexported
v1\peer.go:27:6: exported type Peer should have comment or be unexported
v1\peer.go:57:1: exported function NewPeer should have comment or be unexported
v1\peer.go:76:1: exported method Peer.Start should have comment or be unexported
v1\peer.go:85:1: exported method Peer.Stop should have comment or be unexported
v1\peer.go:90:1: exported method Peer.NotifyAboutPowRequirementChange should have comment or be unexported
v1\peer.go:95:1: exported method Peer.NotifyAboutBloomFilterChange should have comment or be unexported
v1\peer.go:99:1: exported method Peer.NotifyAboutTopicInterestChange should have comment or be unexported
v1\peer.go:103:1: exported method Peer.SetPeerTrusted should have comment or be unexported
v1\peer.go:107:1: exported method Peer.RequestHistoricMessages should have comment or be unexported
v1\peer.go:111:1: exported method Peer.SendMessagesRequest should have comment or be unexported
v1\peer.go:115:1: exported method Peer.SendHistoricMessageResponse should have comment or be unexported
v1\peer.go:125:1: exported method Peer.SendP2PMessages should have comment or be unexported
v1\peer.go:129:1: exported method Peer.SendRawP2PDirect should have comment or be unexported
v1\peer.go:133:1: exported method Peer.SetRWWriter should have comment or be unexported
v1\peer.go:147:1: exported method Peer.BloomFilter should have comment or be unexported
v1\peer.go:156:1: exported method Peer.PoWRequirement should have comment or be unexported
v1\peer.go:160:1: exported method Peer.ConfirmationsEnabled should have comment or be unexported
v1\peer.go:170:1: exported method Peer.EnodeID should have comment or be unexported
v1\peer.go:174:1: exported method Peer.IP should have comment or be unexported
v1\peer.go:178:1: exported method Peer.Run should have comment or be unexported
v1\status_options.go:41:1: exported function StatusOptionsFromHost should have comment or be unexported
v1\status_options.go:128:1: exported method StatusOptions.PoWRequirementF should have comment or be unexported
v1\status_options.go:136:1: exported method StatusOptions.SetPoWRequirementFromF should have comment or be unexported
v1\status_options.go:141:1: exported method StatusOptions.EncodeRLP should have comment or be unexported
v1\status_options.go:160:1: exported method StatusOptions.DecodeRLP should have comment or be unexported
v1\status_options.go:207:1: exported method StatusOptions.Validate should have comment or be unexported

Running the golint command on the project root gives a massive list of linting issues.

Implementation

• [ ] Decide if we want to check for golint linting issues
• [ ] Remove linting issues from the repo
• [ ] Implement golint checks in automated lint checks

Acceptance Criteria

Provided we make the decision to address golint linting issues following the Implementation steps above.

[status-github-bot[bot]]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.