libp2p / js-peer-id

peer-id implementation in JavaScript. Deprecated; use https://github.com/libp2p/js-libp2p-peer-id instead.
https://github.com/libp2p/js-libp2p-peer-id
MIT License
80 stars 44 forks source link

no documentation for isPeerId #134

Closed a1300 closed 3 years ago

a1300 commented 3 years ago

@vasco-santos

Under which subcategory should PeerId.isPeerId() be documented? Currenty in the README.md we have the subcategories

vasco-santos commented 3 years ago

humm, not really any of them. Meanwhile, we can add it to a "Others" category. We will be looking into adding jsdoc everywhere and generate docs from there, not really sure on the structure yet, so we can do this for now