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

documentation drive: #24

Open
dominictarr opened this issue Mar 20, 2019 · 3 comments
Open

documentation drive: #24

dominictarr opened this issue Mar 20, 2019 · 3 comments

Comments

@dominictarr
Copy link
Contributor

@corlock wrote:

General documentation of EBT's makes sense, but what was unclear to me was where the actual networking and message propagation is handled. My current understanding is that this is connected to the createStream method, which isn't really documented in this module. It is referenced, but not made explicit what that means or how streams interface with EBT.

would an example clear it up? hmm, I see it just says

var stream = ebt.createStream('bob')
stream.pipe(remote_stream).pipe(stream)

that's a pattern that will be familiar if you know my earlier streams work, but isn't explained or an explaination linked to, not sure where that documentation should be. But it should be somewhere.

@clevinson
Copy link

👋 hey! just a heads up that i'm @clevinson over on github :) same person as corlock on ssb..

@dominictarr
Copy link
Contributor Author

@clevinson thanks for pointing that out!

@dominictarr
Copy link
Contributor Author

@clevinson reports the following methods are undocumented:

method name documented
ebt.streams  
ebt.state  
ebt.logging  
ebt.pause(id, paused)  
ebt.block(id, target, value)  
ebt.createStream(remote_id, version, client)  
ebt.update()  

%94jvRYQ+QOX4xUCGdGLsdDpZkRFLewOxEXFCdbIuy6o=.sha256

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants