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.

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

Docs: golint-ify "importers" module #4640

Merged
merged 3 commits into from
Feb 3, 2018
Merged

Conversation

hsanjuan
Copy link
Contributor

@hsanjuan hsanjuan commented Feb 1, 2018

This fixes all golint warnings in the importers module, adding
documentation and module descriptions.

License: MIT
Signed-off-by: Hector Sanjuan hector@protocol.ai

This fixes all golint warnings in the importers module, adding
documentation and module descriptions.

License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
@hsanjuan hsanjuan self-assigned this Feb 1, 2018
@ghost ghost added the status/in-progress In progress label Feb 1, 2018
// Layout builds a balanced DAG. Data is stored at the leaves
// and depth only increases when the tree is full, that is, when
// the root node has reached the maximum number of links.
func Layout(db *h.DagBuilderHelper) (ipld.Node, error) {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Be aware there are two or three API changes due to stuttering.

Copy link
Contributor

@kevina kevina Feb 2, 2018

Choose a reason for hiding this comment

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

Does golint complain about stuttering or is that just a personal preference?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It complains about it

I changed it unnoticedly.

License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
License: MIT
Signed-off-by: Hector Sanjuan <hector@protocol.ai>
Copy link
Member

@whyrusleeping whyrusleeping left a comment

Choose a reason for hiding this comment

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

The best kind of PR

@whyrusleeping whyrusleeping merged commit 8e6519b into master Feb 3, 2018
@whyrusleeping whyrusleeping deleted the doc/godoc-importer branch February 3, 2018 23:30
@ghost ghost removed the status/in-progress In progress label Feb 3, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants