Skip to content
This repository has been archived by the owner on Aug 24, 2021. It is now read-only.

Awesome API Documentation #5

Merged
merged 3 commits into from
Dec 14, 2016
Merged

Awesome API Documentation #5

merged 3 commits into from
Dec 14, 2016

Conversation

dignifiedquire
Copy link
Member

@dignifiedquire dignifiedquire commented Dec 6, 2016

@dignifiedquire dignifiedquire changed the title [WIP] Awesome API Documentation Awesome API Documentation Dec 12, 2016
* by `func`.
*
* @param {Buffer} buf - The value to hash.
* @param {number|string} func - The algorithm to use.
Copy link
Member

Choose a reason for hiding this comment

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

Hm, this looks weird, func should be number or string. Reason would be because we change the argument orders if there are optional arguments. However, I can see this being confusing. Any ideas on how we can make it better?

Copy link
Member Author

Choose a reason for hiding this comment

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

I'm not sure I understand, is your issue the name func, because the definition I wrote is number or string.

@daviddias
Copy link
Member

Users won't find API with only this https://github.com/multiformats/js-multihashing-async#api

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.

3 participants