Addresses some IDE warnings relating to GoDoc comments #76
Conversation
This addresses some warnings mostly around the convention of the first word of a godoc being the same as the exported symbol. This also addresses some typos and some micronits. Any or all of this can be dismissed if not welcome. I'm just raising this as noticed while reviewing the code! Signed-off-by: Adrian Cole <adrian@tetrate.io>
| // resolved variable index used by the interpreter; Name is the | ||
| // original name used by String(). | ||
| // VarExpr is a variable reference (special var, global, or local). | ||
| // Index is the resolved variable index used by the interpreter; Name |
There was a problem hiding this comment.
I looked and figure based on common lengths that we are using max 70 columns here.
| @@ -232,7 +234,7 @@ func (e *AugAssignExpr) String() string { | |||
| return e.Left.String() + " " + e.Op.String() + "= " + e.Right.String() | |||
| } | |||
|
|
|||
| // Increment or decrement expression like x++ or --y. | |||
| // IncrExpr is an increment or decrement expression like x++ or --y. | |||
There was a problem hiding this comment.
I made a lot of judgment calls to avoid stuttering where possible, but sometimes it wasn't.
| @@ -12,6 +12,7 @@ const ( | |||
| CONCAT // Not really a token, but used as an operator | |||
|
|
|||
| // Symbols | |||
|
|
|||
There was a problem hiding this comment.
this extra line prevents the section comment from being mistaken as documentation for ADD
|
Thanks! I pushed one more tweak, namely changing "etc." to "and so on", as I think it reads better anyway. I'll merge this now. |
|
Out of interest, are you using GoAWK for any project in particular, or did you just stumble across it? |
|
Thanks for merging!
I'm studying your work because we are thinking about a parser for WebAssembly's text format, which has some interesting twists and turns in it. I also have been looking at mugo for the same reason. Being able to parse |
|
Nice, thanks for the info! |
This addresses some warnings mostly around the convention of the first
word of a godoc being the same as the exported symbol. This also
addresses some typos and some micronits. Any or all of this can be
dismissed if not welcome. I'm just raising this as noticed while
reviewing the code!