lint: add revive for exported docstrings

Author: bitromortac

.golangci.yml

@@ -26,6 +26,14 @@ linters-settings:
       - G115 # Integer overflow conversion.
   staticcheck:
     checks: ["-SA1019"]
+  revive:
+    rules:
+      - name: exported # To enforce conventions around exported comments.
+
+issues:
+  include:
+    - EXC0012 # revive: Exported vars should have a docstring.
+    - EXC0014 # revive: Exported vars's docstring should start with its name.
 
 linters:
   enable-all: true
@@ -92,7 +100,6 @@ linters:
   - importas
   - interfacebloat
   - protogetter
-  - revive
   - depguard
   - mnd
   - perfsprint

chainnotifier_client.go

@@ -29,7 +29,7 @@ type NotifierOptions struct {
 	ReOrgChan chan struct{}
 }
 
-// defaultNotifierOptions returns the set of default options for the notifier.
+// DefaultNotifierOptions returns the set of default options for the notifier.
 func DefaultNotifierOptions() *NotifierOptions {
 	return &NotifierOptions{}
 }

lightning_client.go

@@ -3302,6 +3302,7 @@ func (s *lightningClient) CloseChannel(ctx context.Context,
 	return updateChan, errChan, nil
 }
 
+// InboundFee holds the inbound fee policy for a channel.
 type InboundFee struct {
 	// BaseFeeMsat is the inbound base fee charged regardless of the number
 	// of milli-satoshis received in the channel. By default, only negative

macaroon_pouch.go

@@ -13,6 +13,7 @@ import (
 // with a specific lnrpc service.
 type LnrpcServiceMac string
 
+//nolint:revive
 const (
 	AdminServiceMac         LnrpcServiceMac = "admin.macaroon"
 	InvoiceServiceMac       LnrpcServiceMac = "invoices.macaroon"

walletkit_client.go

@@ -648,7 +648,7 @@ func unmarshallOutputType(o lnrpc.OutputScriptType) txscript.ScriptClass {
 	}
 }
 
-// RPCTransaction returns a rpc transaction.
+// UnmarshalTransactionDetail returns a rpc transaction.
 func UnmarshalTransactionDetail(tx *lnrpc.Transaction,
 	chainParams *chaincfg.Params) (*lnwallet.TransactionDetail, error) {