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.

Sign up for GitHub

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

Jump to bottom

ipfsd init start docs and behavior don't match #289

Closed
hugomrdias opened this issue Aug 27, 2018 · 0 comments · Fixed by #291
Closed

ipfsd init start docs and behavior don't match #289

hugomrdias opened this issue Aug 27, 2018 · 0 comments · Fixed by #291
Assignees
@hugomrdias
Labels
exp/novice Someone with a little familiarity can pick up kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up topic/docs Documentation

Comments

@hugomrdias
Copy link
Member

https://github.com/ipfs/js-ipfsd-ctl/blob/master/README.md#initinitopts-callback
should be ipfsd.init([initOpts], callback) and also says init returns ipfsd be it doesn't.

https://github.com/ipfs/js-ipfsd-ctl/blob/master/README.md#ipfsdstartflags-callback
says it returns ipfsAPI be doesn't.

Probably all should return ipfsd.
@hugomrdias hugomrdias added kind/bug A bug in existing code (including security flaws) exp/novice Someone with a little familiarity can pick up P1 High: Likely tackled by core team if no one steps up topic/docs Documentation labels Aug 27, 2018
hugomrdias added a commit that referenced this issue Aug 28, 2018
@hugomrdias
fix: fix ipfsd.init return value
94e4d89 
init should return ipfsd instance in the callback but didn't

closes #289
@hugomrdias hugomrdias mentioned this issue Aug 28, 2018
Merged
@ghost ghost assigned hugomrdias Aug 28, 2018
@ghost ghost added the status/in-progress In progress label Aug 28, 2018
hugomrdias added a commit that referenced this issue Aug 29, 2018
@hugomrdias
fix: fix ipfsd.init return value (#291)
3fa63e3 
init should return ipfsd instance in the callback but didn't

closes #289
@ghost ghost removed the status/in-progress In progress label Aug 29, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hugomrdias hugomrdias

Labels
exp/novice Someone with a little familiarity can pick up kind/bug A bug in existing code (including security flaws) P1 High: Likely tackled by core team if no one steps up topic/docs Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: fix ipfsd.init return value ipfs/js-ipfsd-ctl
1 participant
@hugomrdias