这是indexloc提供的服务,不要输入任何密码
Skip to content
This repository was archived by the owner on Feb 13, 2025. It is now read-only.

Conversation

@muffix
Copy link
Member

@muffix muffix commented May 17, 2020


Description

This adds documentation to all exported functions of all packages.

Before this change:

$ make golint
(...)
Found 861 lint suggestions; failing.
make: *** [golint] Error 1

Now:

$ make golint
(...)
Found 187 lint suggestions; failing.
make: *** [golint] Error 1

All remaining complaints by golint are about the naming of structs and fields that should be reviewed separately.

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

  • Automated unit tests

Checklist:

  • This contribution follows the project's code of conduct
  • This contribution follows the project's contributing guidelines
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@muffix muffix force-pushed the fix-linter-issues branch from b6195ef to b043c76 Compare May 18, 2020 09:00
@muffix muffix force-pushed the fix-linter-issues branch 5 times, most recently from 1a2e67e to dcca442 Compare May 18, 2020 22:11
@muffix muffix force-pushed the fix-linter-issues branch from dcca442 to 2bc9c92 Compare May 18, 2020 22:12
@muffix muffix closed this May 13, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant