Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix golint warnings #422

Merged
merged 6 commits into from
Mar 12, 2019
Merged

Fix golint warnings #422

merged 6 commits into from
Mar 12, 2019

Commits on Mar 11, 2019

  1. Add documentation comments 

    golint now requires all exported types, methods, and constants to
have documentation comments on them. And the comments should have
a particular style, starting with the identifier they describe.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    395d87a View commit details
    Browse the repository at this point in the history

  2. Unexport implementation details 

    These constants should not be exported, they are for internal use.
Spell them with a lowercase initial letter instead of uppercase.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    41940de View commit details
    Browse the repository at this point in the history

  3. Replace snake_case with camelCase 

    Go code style requires to use camelCase for variables, not snake_case.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    9569887 View commit details
    Browse the repository at this point in the history

  4. Spell ID as "ID", not "Id" 

    golint warns us about incorrect spelling, fix it where possible.

Don't rename GetRemoteId and GetPublicKeyForId methods to avoid
breaking backward compatibility.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    ae549e4 View commit details
    Browse the repository at this point in the history

  5. Drop explicit zero initialization 

    Values are zero-initialized by default, golint warns about explicit
zero initialization. Remove it.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    2fdc701 View commit details
    Browse the repository at this point in the history

  6. Replace snake_case with camelCase: docs/examples 

    There are more Go files which may trigger golint spellchecker. Fix
identified casing there as well.
    @ilammy
    ilammy committed Mar 11, 2019
    Configuration menu
    Copy the full SHA
    1f81646 View commit details
    Browse the repository at this point in the history