Skip to content

/graph fix lint errors/warnings#14827

Merged
tiborvass merged 1 commit intomoby:masterfrom
brahmaroutu:lint_graph
Jul 29, 2015
Merged

/graph fix lint errors/warnings#14827
tiborvass merged 1 commit intomoby:masterfrom
brahmaroutu:lint_graph

Conversation

@brahmaroutu
Copy link
Contributor

Addresses #14756
Signed-off-by: Srini Brahmaroutu srbrahma@us.ibm.com

@icecrime
Copy link
Contributor

Ping @stevvooe!

graph/export.go Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Document the struct's fields, as well.

@stevvooe
Copy link
Contributor

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 graph package is subtle and full of archaeology that should be reflected in the godoc. It is going to take time to get proper doc comments in.

@jessfraz jessfraz changed the title /graph fix lin errors/warnings /graph fix lint errors/warnings Jul 22, 2015
@brahmaroutu
Copy link
Contributor Author

@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.

@stevvooe
Copy link
Contributor

@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.

@brahmaroutu brahmaroutu force-pushed the lint_graph branch 2 times, most recently from 3a20eeb to 0fdebd5 Compare July 23, 2015 21:59
graph/export.go Outdated
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AuthConfig holds authentication information for authorizing with the registry

graph/tags.go Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

replace "is a interface" by "is an interface"

@stevvooe
Copy link
Contributor

LGTM

@aaronlehmann PTAL

@gdevillele
Copy link
Contributor

LGTM

@aaronlehmann
Copy link

LGTM

@stevvooe
Copy link
Contributor

@icecrime @jfrazelle Would like to merge but the CI system seems to be failing on something unrelated. Any thoughts?

@tiborvass
Copy link
Contributor

@stevvooe For these golint PRs, I just merge nevertheless, after testing locally.

@tiborvass
Copy link
Contributor

LGTM

tiborvass added a commit that referenced this pull request Jul 29, 2015
/graph fix lint errors/warnings
@tiborvass tiborvass merged commit 28b79e4 into moby:master Jul 29, 2015
@stevvooe
Copy link
Contributor

@tiborvass There are a few symbol changes that need to be checked on build.

@tiborvass
Copy link
Contributor

@stevvooe what do you mean?

@stevvooe
Copy link
Contributor

@tiborvass graph.DEFAULTTAG -> graph.DefaultTag should be checked by CI.

@tiborvass
Copy link
Contributor

@stevvooe I checked locally because CI was down

@brahmaroutu brahmaroutu deleted the lint_graph branch August 12, 2015 18:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

10 participants