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

adds more info about chunker option #4306

Merged
merged 2 commits into from
Oct 23, 2017

Conversation

thisconnect
Copy link
Contributor

see #4276

License: MIT
Signed-off-by: Enrique Erne enrique.erne@gmail.com

see ipfs#4276

License: MIT
Signed-off-by: Enrique Erne <enrique.erne@gmail.com>
Copy link
Member

@magik6k magik6k left a comment

Choose a reason for hiding this comment

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

It's probably better to put this description in LongDescription, to keep option lines short(-ish)

@Stebalien Stebalien self-assigned this Oct 14, 2017
License: MIT
Signed-off-by: Enrique Erne <enrique.erne@gmail.com>
@whyrusleeping
Copy link
Member

Yeah, definitely worth having this + examples in the LongDescription section.

@whyrusleeping
Copy link
Member

Thanks for the PR @thisconnect, documentation additions are the best :)

@thisconnect
Copy link
Contributor Author

Sorry my internet a bit wonky I am traveling. Explaining the option in LongDescription does make sense, but the short one also needs something more descriptive than Chunking algorithm to use. + Default

What do you all think about the latest commit? Still too long?

@whyrusleeping
Copy link
Member

@thisconnect That looks good to me! Mind also adding something to the long description while we're at it? Maybe a few examples?

@whyrusleeping whyrusleeping merged commit fda7dd1 into ipfs:master Oct 23, 2017
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.

5 participants