search

jedisct1 / libsodium.js

libsodium compiled to Webassembly and pure JavaScript, with convenient wrappers.
Other
968 stars 138 forks source link

`crypto_pwhash_*` function set documentation in npm and repository README differs #324

Closed marcel-idana closed 1 year ago

marcel-idana commented 1 year ago

Thanks for the clarification in d297e49dd804bfb7c664cd58be1cdf012e0f3aea :)

The documentation on npmjs.com at libsodium-wrappers and libsodium-wrappers-sumo states

The crypto_pwhash_* function set is included in both versions.

and this is not correct. But the documentation here in the README is correct:

The crypto_pwhash_* function set is only included in the sumo version.

I do not know how to update the npm documentation. What I can say that it was very confusing installing libsodium-wrappers and getting an error for calling for crypto_pwhash_*.

jedisct1 commented 1 year ago

Is the documented printed on npmjs independent from the documentation in the package?

My intuition was the it was just the README file of the package, and I don't see any button to change it.

So maybe only releasing a new version can update the documentation.

marcel-idana commented 1 year ago

libsodium-wrappers

Thanks for the really quick reply! Honestly I don't know how this works and your explanation makes sense. Maybe this issue is not that important. Also I have observed that the documentation on npmjs is gone. What would be good if this is not only the case on my machine and was so intended because there would be only one source of truth for now. For me this issue is resolved and maybe the next release will have the documentation in sync :) Thanks a lot for the great work :)