search

telehash / telehash.github.io

Contents of the site
http://telehash.org/
Other
483 stars 59 forks source link

Add example JSON snippets to transports #138

Closed bachp closed 9 years ago

bachp commented 9 years ago

@quartzjer I didn't know what would go into the signal for WebRTC. If you can tell me I will replace the TODO. If not I will add it later.

quartzjer commented 9 years ago

If any of those make sense just update or reply and I'll get this merged, good stuff :+1:

bachp commented 9 years ago

I updated the commit according your comment. Should be good to merge now. Just one thing: I was wondering if there are path json examples for other transports as-well (tls, bluetooth,802.15.4?), because there I didn't find any examples.

quartzjer commented 9 years ago

Right, those are just stubs, suggestions on a good way to signal that those transports are planned in the docs?

There's issues for most things that are stubs already, but it's nice to have some pointer to that state in the spec in the right places as well.

bachp commented 9 years ago

I fixed my wrong fix ;) Just to make sure I understand your last commit correctly. By "pointers in the spec" you mean TODOs?

I have quite good experience with TODO: as it allows to easily grep for it in the source.

quartzjer commented 9 years ago

Yeah, in a protocol spec it's more of a "draft" state than a code TODO though, I'm going to file an issue to do a consistency check on all the draft aspects and flag them.