From 45376ddb0502a96be96adf322dc9688bb4e485dd Mon Sep 17 00:00:00 2001 From: Abhinav Gupta Date: Sat, 24 Aug 2019 12:15:39 -0700 Subject: [PATCH] ast: Specify types for iota-based constants Including the type of a constant improves discoverability because the constant is listed next to the type in the godocs. Before: ``` $ go doc -all . WalkStatus type WalkStatus int WalkStatus represents a current status of the Walk function. ``` After: ```shell $ go doc -all . WalkStatus type WalkStatus int WalkStatus represents a current status of the Walk function. const ( // WalkStop indicates no more walking needed. WalkStop WalkStatus = iota + 1 // WalkSkipChildren indicates that Walk wont walk on children of current // node. WalkSkipChildren // WalkContinue indicates that Walk can continue to walk. WalkContinue ) ``` This commit the `iota`-based constants in the AST package to follow this. --- ast/ast.go | 5 +++-- ast/block.go | 5 +++-- ast/inline.go | 2 +- 3 files changed, 7 insertions(+), 5 deletions(-) diff --git a/ast/ast.go b/ast/ast.go index ddc2272..8645d31 100644 --- a/ast/ast.go +++ b/ast/ast.go @@ -4,9 +4,10 @@ package ast import ( "bytes" "fmt" + "strings" + textm "github.com/yuin/goldmark/text" "github.com/yuin/goldmark/util" - "strings" ) // A NodeType indicates what type a node belongs to. @@ -412,7 +413,7 @@ type WalkStatus int const ( // WalkStop indicates no more walking needed. - WalkStop = iota + 1 + WalkStop WalkStatus = iota + 1 // WalkSkipChildren indicates that Walk wont walk on children of current // node. diff --git a/ast/block.go b/ast/block.go index 69a74d1..f63619f 100644 --- a/ast/block.go +++ b/ast/block.go @@ -2,8 +2,9 @@ package ast import ( "fmt" - textm "github.com/yuin/goldmark/text" "strings" + + textm "github.com/yuin/goldmark/text" ) // A BaseBlock struct implements the Node interface. @@ -397,7 +398,7 @@ type HTMLBlockType int const ( // HTMLBlockType1 represents type 1 html blocks - HTMLBlockType1 = iota + 1 + HTMLBlockType1 HTMLBlockType = iota + 1 // HTMLBlockType2 represents type 2 html blocks HTMLBlockType2 // HTMLBlockType3 represents type 3 html blocks diff --git a/ast/inline.go b/ast/inline.go index 8c20402..da0f720 100644 --- a/ast/inline.go +++ b/ast/inline.go @@ -447,7 +447,7 @@ type AutoLinkType int const ( // AutoLinkEmail indicates that an autolink is an email address. - AutoLinkEmail = iota + 1 + AutoLinkEmail AutoLinkType = iota + 1 // AutoLinkURL indicates that an autolink is a generic URL. AutoLinkURL )