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

[WIP] Awesome API docs #41

Closed
wants to merge 5 commits into from
Closed

[WIP] Awesome API docs #41

wants to merge 5 commits into from

Conversation

dignifiedquire
Copy link
Member

No description provided.

@daviddias
Copy link
Member

It is my impression, or Coveralls forgot that we deactivated them all and now comments in all PRs?

@dignifiedquire
Copy link
Member Author

@diasdavid no we just haven't disabled them everywhere yet

@harlantwood
Copy link

Nice. One nit: http://libp2p.github.io/js-peer-id/#Introduction should probably link back to https://github.com/libp2p/js-peer-id , in case someone lands there from search or something...

Copy link
Member

@victorb victorb left a comment

Choose a reason for hiding this comment

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

Looks good except one typo! 👍

src/index.js Outdated
get privKey () {
return this._privKey
}

/**
* The private key of this id, if it exists.
Copy link
Member

Choose a reason for hiding this comment

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

"The public key of this id"

@dignifiedquire
Copy link
Member Author

@harlantwood just updated and added a github link: http://libp2p.github.io/js-peer-id/

@daviddias daviddias changed the title [WIP] Api docs [WIP] Awesome API docs Dec 10, 2016
@daviddias daviddias added status/ready Ready to be worked and removed status/in-progress In progress labels Jan 19, 2017
@vasco-santos
Copy link
Member

Closing this as we already have the API docs in the README and these are outdated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/ready Ready to be worked
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants