Skip to content

Conversation

domfarolino
Copy link
Member

Will close: #79.

I am not sure if the h3 Printer header will need any special symbols on the options 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.

@domfarolino domfarolino requested a review from domenic March 30, 2017 20:30
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>
Copy link
Member

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.

Copy link
Member Author

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>
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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.

Copy link
Member Author

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

Copy link
Member

@domenic domenic left a 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>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Double commas

@domfarolino domfarolino merged commit 5ec6837 into master Apr 4, 2017
@domfarolino domfarolino deleted the nodejs-dir branch April 4, 2017 13:08
@robertkowalski
Copy link
Member

wow great work

<3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Node.js console.dir

3 participants