docs: add guidelines for func declarations [skip ci]

This commit is contained in:
positiveblue 2022-01-31 18:19:11 -08:00
parent 60625b6c1a
commit d2143bd40f
No known key found for this signature in database
GPG Key ID: 4FFF2510928804DC

View File

@ -485,8 +485,34 @@ statements and select statements.
```
If one is forced to wrap lines of function arguments that exceed the 80
character limit, then a new line should be inserted before the first stanza in
the comment body.
character limit, then identation must be kept on the following lines. Also,
lines should not end with an open open parenthesis.
**WRONG**
```go
func foo(a, b, c,
) (d, error) {
func bar(a, b, c) (
d, error,
) {
func baz(a, b, c) (
d, error) {
```
**RIGHT**
```go
func foo(a, b,
c) (d, error) {
func baz(a, b, c) (d,
error) {
```
If a function declaration spans multiple lines the body should start with an
empty line.
**WRONG**
```go