Update WebIDL and modify documentation to fit new "node.js-like" style, Part 2 #1893
Conversation
be syntactically correct and to follow the new style of buffer.md. Added a new file that explains some of the differences between WebIDL and Javascript.
Some changes to a few .md files to get feedback.
Modified format and fixed WebIDL
…#1881) Thanks to Paul Sokolovsky for finding this solution. Signed-off-by: Geoff Gustafson <[email protected]>
Created shim layer for building against the POSIX network stack on Zephyr which enables the debugger to run on the frdm_k64f board with TCP IPV4 on port 5001. Signed-off-by: Jimmy Huang <[email protected]>
Signed-off-by: Jimmy Huang <[email protected]>
Signed-off-by: Jimmy Huang <[email protected]>
Signed-off-by: Timothy Harvey <[email protected]>
Signed-off-by: Timothy Harvey <[email protected]>
Signed-off-by: Timothy Harvey <[email protected]>
…into modify_docs2
…into modify_docs2 Signed-off-by: Timothy Harvey <[email protected]>
into modify_docs2 Signed-off-by: Timothy Harvey <[email protected]>
Signed-off-by: Timothy Harvey <[email protected]>
|
@t-harvey looks good to me, thank you for sending this patch and help us fixing up the web-idls, definilte a lot better than the previous one, we are okay with merging this patch as is, but I would like to know if there's a reason to use |
|
Jimmy, |
|
Yeah, I looked through it too and looks good. Since it's all in documentation there should be no problem with just merging it. :) @t-harvey are you sure you still needed the |
docs/ble.md
Outdated
| // require returns a BLE object | ||
| // var ble = require('ble'); | ||
|
|
||
| [NoInterfaceObject] | ||
| <p><p> |
There was a problem hiding this comment.
Here's where there are a bunch of double blanks; there are others around though.
There was a problem hiding this comment.
Geoff,
Since both you and Jimmy noticed, this, I'll go back and rip out as many as possible... :-)
There was a problem hiding this comment.
...also, I, too, thought the pre-construct inside of the details-construct would suffice for formatting, but I just went back and checked, and it doesn't do the trick; the only thing that worked was to wrap the pre-construct around the details-construct (instead of the other way around), but then the pulldown menu is in the wrong font, which looks ugly...
I can make this switch (i.e., put the pre-construct first), if you guys want, but as the html-newlines are invisible to everyone except us, I'm more inclined to leave it pretty but (mildly) cumbersome. :-)
I've uploaded one file to show what swapping the two constructs looks like -- once Travis has its way with the docs, compare/contrast the docs for i2c.
There was a problem hiding this comment.
Yeah, I think the old way was better.
There was a problem hiding this comment.
Great -- I'll clean up the git record (so expect a --force'd commit :-), remove as many newlines as I can aesthetically :-), and put in a final upload.
Signed-off-by: Timothy Harvey <[email protected]>
Signed-off-by: Timothy Harvey <[email protected]>
…into modify_docs2 Signed-off-by: Timothy Harvey <[email protected]>
|
LGTM +1 |
Folks,
This is the actual pull request for updating the documentation to: 1) follow the style of node.js and 2) correct the WebIDL.
I tried to incorporate the advice/corrections from the original test pull request (#1800).
As with the test pull request, I've limited myself to fixing grammatical errors and the actual WebIDL, but the documentation could definitely do with a thorough going over for technical detail as well.
That said, I've run all of the updated WebIDL through my own parser, and it all builds correctly. I wrote an automated tester for this, but I'm largely a newbie, so I don't know where I can put it and how to get it to run as part of the automated testing; any advice, pointers, etc. would be very useful.
Thanks,
Tim