Language for grouping methods #95

domfarolino · 2017-03-15T04:43:06Z

Since I put some group-specific logic inside Printer (see "When a group gets printed, output produced by future calls...") should we have a new log level "group" for this to be a little more detectable and rigorous? This would be used inside group() and groupCollapsed().

I think the language describing a group is both helpful and vague enough to allow browsers to implement this one way, and Node another (possibly even with prefixes since previously outputted data typically is non-interactive) while still being compliant. Thoughts?

Addresses #94

domenic

I think this would be much more explicit if there was a pointer to the current group and its parent group or similar, which were explicitly modified by group/groupCollapsed/clear/groupEnd. Maybe a group stack even, although I guess it's equivalent.

Then Printer could talk about how it prints things in the context of the current group.

WDYT?

domenic · 2017-03-15T21:38:01Z

index.bs

@@ -239,7 +239,7 @@ its \[[Prototype]] an empty object, created as if by ObjectCreate(%ObjectPrototy

 <h4 id="clear" oldids="dom-console-clear" method for="console">clear()</h4>

-If possible for the environment, clear the console. Otherwise, do nothing.
+End all open groups, and if possible for the environment, clear the console. Otherwise, do nothing.


<a>groups</a> I think

Nice. I didn't realize <a>groups</a> would behave like <a>group</a>

domenic · 2017-03-15T21:38:47Z

index.bs

@@ -287,12 +287,30 @@ Perform Logger("warn", <var>data</var>).

 <h3 id="grouping">Grouping methods</h3>

+A <dfn>group</dfn> is an implementation-specific, potentially-interactive view for output produced by calls to Printer, with one further level of indentation than its parent. A group may host output produced by calls to Printer until it is ended with <a>groupEnd()</a>, and only one group will host output produced by calls to Printer at a time.


<a>groupEnd()</a> should be {{console/groupEnd()}} to get the right formatting.

domenic · 2017-03-15T21:39:23Z

index.bs

+<emu-alg>
+  1. Let _group_ be a new <a>group</a>.
+  1. Let _groupLabel_ be the result of Formatter(data), and incorporate _groupLabel_ as a label for _group_.
+  1. Optionally if the environment supports interactive groups, _group_ should be expanded by default.


Nit: comma after "Optionally"

domenic · 2017-03-15T21:40:29Z

index.bs

@@ -143,7 +143,7 @@ The following is an informative summary of the format specifiers processed by th

 The printer operation is implementation-defined. It accepts a log level indicating severity, and a List of arguments to print (which are either JavaScript objects, of any type, or are implementation-specific representations of printable things such as a stack trace, or output produced by the <code>%o</code> and <code>%O</code> specifiers). How the implementation prints <var>args</var> is up to the implementation, but implementations should separate the objects by a space or something similar, as that has become a developer expectation.


I think the list of things that arguments can contain (in parenthesis) needs to be expanded to include the group concept.

domfarolino · 2017-03-15T23:54:26Z

Ah I almost went with a group stack but didn't know if it would be a bit much! I'll put something together referring to a group stack. Should this "global" group stack be first introduced in the text defining what a group is, or do you think it would be better somewhere in the top "abstract" area?

domenic · 2017-03-16T00:10:06Z

Hmm interesting question. I guess I might make it something associated with each console namespace object?

domfarolino · 2017-03-16T16:51:11Z

associated with each console namespace object?

Sorry, could you elaborate a bit? Are you saying it can be written in IDL under the console namespace or am I missing the idea?

In general I guess I'm not really sure how to write something that is properly "global" to the other operations. I naturally lean toward putting it near the abstract operations area because things like Printer() and Logger() are exposed everywhere without being expressed in IDL which seems convenient for private/internal implementation book-keeping.

domenic · 2017-03-16T18:35:47Z

Sorry, could you elaborate a bit? Are you saying it can be written in IDL under the console namespace or am I missing the idea?

Oh, no, I meant just something like "each console namespace object has an associated group stack, which is a stack (initially empty)."

You're right that Printer and Logger are kind of global. Maybe they should take the console object as a parameter. After all if you were implementing this you'd need some way to make sure that Printer() sends things to the right instance of developer tools.

Alternately you can just say something like "the appropriate group stack" and keep things vague. That seems fine too IMO.

domfarolino · 2017-03-16T19:59:00Z

For simplicity I opted to use "appropriate group stack" instead of modify all the abstract ops to take in an instance of the correct console namespace object. Perhaps this should be looked into further at some point.

If the above changes are good, I guess the only thing left is recommending that the default group label not be an empty string if ...data is empty.

domenic · 2017-03-16T21:50:43Z

index.bs

+  1. Let _groupLabel_ be the result of Formatter(data), and incorporate _groupLabel_ as a label for _group_.
+  1. Optionally, if the environment supports interactive groups, _group_ should be expanded by default.
+  1. Perform Printer("log", «_group_»).
+  1. Push _group_ onto the appropriate <a>group stack</a>


Missing period. Also you can do <a>Push</a> (maybe <a for="stack">Push</a> will be necessary). You can feel free to not link to such basic infra terms if you think it's silly though; that's up to editor discretion.

domenic · 2017-03-16T21:50:51Z

index.bs

+  1. Let _groupLabel_ be the result of Formatter(data), and incorporate _groupLabel_ as a label for _group_.
+  1. Optionally, if the environment supports interactive groups, _group_ should be collapsed by default.
+  1. Perform Printer("log", «_group_»).
+  1. Push _group_ onto the appropriate <a>group stack</a>


Same as above on both counts

domenic · 2017-03-16T21:50:58Z

index.bs

 <h4 id="groupend" oldids="dom-console-groupend" method for="console">groupEnd()</h4>

+Pop the last <a>group</a> from the <a>group stack</a>.


Can optionally link to pop

I could not get Push/Pop to link to infra without spec="infra" (found after skimming bikeshed docs). This seems like overkill though; is this normal especially since Stack was picked up so easily?

Oh, that is an infra bug; the terms are not exported for some reason. Will fix, although it'll be ~24 hours before it gets reindexed afterward, so no need to block this PR on it.

Posted whatwg/infra#72

domenic · 2017-03-16T21:52:06Z

index.bs

@@ -239,7 +239,7 @@ its \[[Prototype]] an empty object, created as if by ObjectCreate(%ObjectPrototy

 <h4 id="clear" oldids="dom-console-clear" method for="console">clear()</h4>

-If possible for the environment, clear the console. Otherwise, do nothing.
+End all open <a>groups</a>, and if possible for the environment, clear the console. Otherwise, do nothing.


"End all open groups" should probably be "empty the appropriate group stack" right?

Yep good call

Also, export some list-adjacent terms. Both changes will be useful in whatwg/console#95.

domfarolino · 2017-03-17T15:55:37Z

Thanks!

Also, export some list-adjacent terms. Both changes will be useful in whatwg/console#95.

domfarolino added 3 commits March 14, 2017 23:49

Language for grouping methods and their interaction w/ Printer/clear

396168b

Possibly better wording

9dd5766

Typo

7e472ab

domfarolino self-assigned this Mar 15, 2017

domfarolino requested a review from domenic March 15, 2017 15:19

domenic reviewed Mar 15, 2017

View reviewed changes

domfarolino added 3 commits March 15, 2017 19:46

Fix nits

9da5e5e

Proper formatting

1c1531e

Anchor groups in clear()

d487bdb

Add group to list of printable things

91b937c

Explain group stack

f89c410

domenic reviewed Mar 16, 2017

View reviewed changes

domenic added a commit to whatwg/infra that referenced this pull request Mar 16, 2017

Add the "empty a list" operation

59b589b

Also, export some list-adjacent terms. Both changes will be useful in whatwg/console#95.

domenic mentioned this pull request Mar 16, 2017

Add the "empty a list" operation whatwg/infra#72

Merged

domfarolino added 2 commits March 16, 2017 19:35

clear() + group/Collapsed fixes etc

b9d7fb7

Add text regarding default group label

a9fe145

domenic approved these changes Mar 17, 2017

View reviewed changes

domfarolino merged commit a44303a into master Mar 17, 2017

domfarolino deleted the grouping-methods branch March 17, 2017 15:55

domenic added a commit to whatwg/infra that referenced this pull request Mar 17, 2017

Add the "empty a list" operation

26ccf0c

Also, export some list-adjacent terms. Both changes will be useful in whatwg/console#95.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Language for grouping methods #95

Language for grouping methods #95

domfarolino commented Mar 15, 2017 •

edited

domenic left a comment

domenic Mar 15, 2017

domfarolino Mar 15, 2017

domenic Mar 15, 2017

domenic Mar 15, 2017

domenic Mar 15, 2017

domfarolino commented Mar 15, 2017

domenic commented Mar 16, 2017

domfarolino commented Mar 16, 2017 •

edited

domenic commented Mar 16, 2017

domfarolino commented Mar 16, 2017

domenic Mar 16, 2017

domenic Mar 16, 2017

domenic Mar 16, 2017

domfarolino Mar 16, 2017

domenic Mar 16, 2017

domenic Mar 16, 2017

domenic Mar 16, 2017

domfarolino Mar 16, 2017

domfarolino commented Mar 17, 2017

		@@ -287,12 +287,30 @@ Perform Logger("warn", <var>data</var>).

		<h3 id="grouping">Grouping methods</h3>

		A <dfn>group</dfn> is an implementation-specific, potentially-interactive view for output produced by calls to Printer, with one further level of indentation than its parent. A group may host output produced by calls to Printer until it is ended with <a>groupEnd()</a>, and only one group will host output produced by calls to Printer at a time.

		@@ -143,7 +143,7 @@ The following is an informative summary of the format specifiers processed by th

		The printer operation is implementation-defined. It accepts a log level indicating severity, and a List of arguments to print (which are either JavaScript objects, of any type, or are implementation-specific representations of printable things such as a stack trace, or output produced by the <code>%o</code> and <code>%O</code> specifiers). How the implementation prints <var>args</var> is up to the implementation, but implementations should separate the objects by a space or something similar, as that has become a developer expectation.

		<h4 id="groupend" oldids="dom-console-groupend" method for="console">groupEnd()</h4>

		Pop the last <a>group</a> from the <a>group stack</a>.

Language for grouping methods #95

Language for grouping methods #95

Conversation

domfarolino commented Mar 15, 2017 • edited

domenic left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domfarolino commented Mar 15, 2017

domenic commented Mar 16, 2017

domfarolino commented Mar 16, 2017 • edited

domenic commented Mar 16, 2017

domfarolino commented Mar 16, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

domfarolino commented Mar 17, 2017

domfarolino commented Mar 15, 2017 •

edited

domfarolino commented Mar 16, 2017 •

edited