-
Notifications
You must be signed in to change notification settings - Fork 73
Support Nodejs dir #107
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
Support Nodejs dir #107
Conversation
index.bs
Outdated
of arguments to print, and an optional object of implementation-specific formatting options. | ||
Elements appearing in <var>args</var> will be one of the following: | ||
|
||
<emu-alg> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this will be better as a <ul>
, not an algorithm. I believe you should be able to use Markdown-like syntax for that.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good call, totally overlooked basic HTML
index.bs
Outdated
</table> | ||
|
||
<h3 id="printer" aoid="Printer" nothrow>Printer(<var>logLevel</var>, <var>args</var>)</h3> | ||
<h3 id="printer" aoid="Printer" nothrow>Printer(<var>logLevel</var>, <var>args</var>, <var>options</var>)</h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Traditionally you do [, options]
to denote optionality.
index.bs
Outdated
<a>optimally useful formatting</a> applied. | ||
</emu-alg> | ||
|
||
Optionally, if the <var>options</var> object is not undefined, implementations can use |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this needs to say something like "If the options object is passed, and is not undefined or null, ..."
|
||
Optionally, if the <var>options</var> object is not undefined, implementations can use | ||
<var>options</var> to apply implementation-specific formatting to the elements in <var>args</var>. | ||
How the implementation prints <var>args</var> is up to the implementation, but implementations |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is nicer as a second paragraph. Once-sentence paragraphs are reasonably common in specs.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Odd, pretty sure I addressed this in my commits though it didn't collapse here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with nit
index.bs
Outdated
</table> | ||
|
||
<h3 id="printer" aoid="Printer" nothrow>Printer(<var>logLevel</var>, <var>args</var>)</h3> | ||
<h3 id="printer" aoid="Printer" nothrow>Printer(<var>logLevel</var>, <var>args</var>, [<var>, options</var>])</h3> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Double commas
wow great work <3 |
Will close: #79.
I am not sure if the
h3
Printer header will need any special symbols on theoptions
object to indicate that it is optional and thus make all other calls to Printer with two arguments valid.This also addresses a small typo I missed when adding text about the group stack in Printer.