Improve code structure, comments and self-descriptive conventions - Githubissues

optakt / flow-dps

Flow Data Provisioning Service

Apache License 2.0

29 stars 13 forks source link

Improve code structure, comments and self-descriptive conventions #388

Closed Ullaakut closed 3 years ago

Ullaakut commented 3 years ago

Description

This issue lists minor improvements that could be done if we agree on them.

We should ensure proper comments for types and methods so that our godoc is clearer.
Ensure that returns have are preceded by a blank line if the function has more than two lines (wsl linter)
Ensure that for statements are only cuddled with assignments used in the iteration (wsl linter)
When implementing an interface and ignoring all arguments in a method, their names should be omitted (no underscore or unused variable name)

Linter issues

rosetta/retriever/retriever.go:161:4: type assertion must be checked (forcetypeassert)
                        balance = result.ToGoValue().(uint64)
api/access/server.go:202:2: var `collId` should be `collID` (golint)
        collId := flow.HashToID(in.Id)

TODO

Add more elements to this issue as we find them. This is an ongoing work.