/graph fix lint errors/warnings#14827
Conversation
|
Ping @stevvooe! |
graph/export.go
Outdated
There was a problem hiding this comment.
Document the struct's fields, as well.
|
Comments are there to help people understand the behavior of a function. This PR just re-states the type signature and seems to be just a find/replace to make lint pass. This is really not in the spirit of effort. The |
|
@stevvooe I have tried my best to address your concerns. Please review and let me know. I have not tried to just get the lint pass but when adding comments to the code the context that I have is very limited. We do the best we can and then we need expertise to fix godocs and some point in time, either we do it as part of this effort or run the godocs with doc experts afterwards. |
|
@brahmaroutu I am not really talking about documentation expertise. We need the expertise of those who have a deep understanding of this code base. Right now, these comments aren't providing any value other than to pass golint. Most additions are still tautological. This isn't background that either you or I possess. It will take some time, study and consideration to get this right, in the absence of tracking down the original authors of this code. It is better to be failing the linter than to have useless method commentary. |
3a20eeb to
0fdebd5
Compare
graph/export.go
Outdated
There was a problem hiding this comment.
Could you complete that one based on the previous comment. ImageExportConfig is used there or at least :
// ImageExportConfig holds list of images name to be exported to a output stream.
graph/pull.go
Outdated
There was a problem hiding this comment.
AuthConfig holds authentication information for authorizing with the registry
graph/tags.go
Outdated
There was a problem hiding this comment.
please fix the name of the function in the comment.
"ValidateRepoName" to "validateRepoName"
Addresses moby#14756 Signed-off-by: Srini Brahmaroutu <srbrahma@us.ibm.com>
graph/push.go
Outdated
There was a problem hiding this comment.
replace "is a interface" by "is an interface"
|
LGTM @aaronlehmann PTAL |
|
LGTM |
|
LGTM |
|
@icecrime @jfrazelle Would like to merge but the CI system seems to be failing on something unrelated. Any thoughts? |
|
@stevvooe For these golint PRs, I just merge nevertheless, after testing locally. |
|
LGTM |
/graph fix lint errors/warnings
|
@tiborvass There are a few symbol changes that need to be checked on build. |
|
@stevvooe what do you mean? |
|
@tiborvass |
|
@stevvooe I checked locally because CI was down |
Addresses #14756
Signed-off-by: Srini Brahmaroutu srbrahma@us.ibm.com