Skip to content

Commit 4abe1bc

Browse files
authored
Editorial: Use implementation-defined more (#240)
1 parent 7a9c402 commit 4abe1bc

File tree

1 file changed

+24
-23
lines changed

1 file changed

+24
-23
lines changed

index.bs

+24-23
Original file line numberDiff line numberDiff line change
@@ -129,15 +129,15 @@ back to just logging the argument if it can't be parsed as tabular.
129129

130130
<h4 id="trace" oldids="trace-data,dom-console-trace" method for="console">trace(...|data|)</h4>
131131

132-
1. Let |trace| be some implementation-specific, potentially-interactive representation of the
132+
1. Let |trace| be some <a>implementation-defined</a>, potentially-interactive representation of the
133133
callstack from where this function was called.
134134
1. Optionally, let |formattedData| be the result of <a abstract-op>Formatter</a>(|data|), and
135135
incorporate |formattedData| as a label for |trace|.
136136
1. Perform <a abstract-op>Printer</a>("trace", « |trace| »).
137137

138138
<p class="note">
139-
The identifier of a function printed in a stack trace is implementation-dependant. It is also not
140-
guaranteed to be the same identifier that would be seen in `new Error().stack`.
139+
The identifier of a function printed in a stack trace is <a>implementation-defined</a>. It is also
140+
not guaranteed to be the same identifier that would be seen in `new Error().stack`.
141141
</p>
142142

143143
<h4 id="warn" oldids="warn-data,dom-console-warn" method for="console">warn(...|data|)</h4>
@@ -183,11 +183,11 @@ Each {{console}} namespace object has an associated <dfn>count map</dfn>, which
183183

184184
<h3 id="grouping">Grouping functions</h3>
185185

186-
A <dfn id="concept-group">group</dfn> is an implementation-specific, potentially-interactive view
187-
for output produced by calls to <a abstract-op>Printer</a>, with one further level of indentation
188-
than its parent. Each {{console}} namespace object has an associated <dfn>group stack</dfn>, which
189-
is a <a>stack</a>, initially empty. Only the last <a>group</a> in a <a>group stack</a> will host
190-
output produced by calls to <a abstract-op>Printer</a>.
186+
A <dfn id="concept-group">group</dfn> is an <a>implementation-defined</a>, potentially-interactive
187+
view for output produced by calls to <a abstract-op>Printer</a>, with one further level of
188+
indentation than its parent. Each {{console}} namespace object has an associated <dfn>group
189+
stack</dfn>, which is a <a>stack</a>, initially empty. Only the last <a>group</a> in a <a>group
190+
stack</a> will host output produced by calls to <a abstract-op>Printer</a>.
191191

192192
<h4 id="group" oldids="group-data,dom-console-group" method for="console">group(...|data|)</h4>
193193

@@ -235,7 +235,7 @@ Each {{console}} namespace object has an associated <dfn>timer table</dfn>, whic
235235
1. Let |timerTable| be the associated <a>timer table</a>.
236236
1. Let |startTime| be |timerTable|[|label|].
237237
1. Let |duration| be a string representing the difference between the current time and
238-
|startTime|, in an implementation-defined format.
238+
|startTime|, in an <a>implementation-defined</a> format.
239239
<p class="example" id="duration-string-example">"4650", "4650.69 ms", "5 seconds", and "00:05"
240240
are all reasonable ways of displaying a 4650.69 ms duration.</p>
241241
1. Let |concat| be the concatenation of |label|, U+003A (:), U+0020 SPACE, and |duration|.
@@ -265,7 +265,7 @@ Each {{console}} namespace object has an associated <dfn>timer table</dfn>, whic
265265
1. Let |startTime| be |timerTable|[|label|].
266266
1. [=map/Remove=] |timerTable|[|label|].
267267
1. Let |duration| be a string representing the difference between the current time and
268-
|startTime|, in an implementation-defined format.
268+
|startTime|, in an <a>implementation-defined</a> format.
269269
1. Let |concat| be the concatenation of |label|, U+003A (:), U+0020 SPACE, and |duration|.
270270
1. Perform <a abstract-op>Printer</a>("timeEnd", « |concat| »).
271271

@@ -279,7 +279,7 @@ console when a given |label| does not exist in the associated <a>timer table</a>
279279
<h3 id="logger" abstract-op lt="Logger">Logger(|logLevel|, |args|)</h3>
280280

281281
The logger operation accepts a log level and a [=/list=] of other arguments. Its main output is the
282-
implementation-defined side effect of printing the result to the console. This specification
282+
<a>implementation-defined</a> side effect of printing the result to the console. This specification
283283
describes how it processes format specifiers while doing so.
284284

285285
1. If |args| is [=list/is empty|empty=], return.
@@ -379,8 +379,8 @@ The following is an informative summary of the format specifiers processed by th
379379

380380
<h3 id="printer" abstract-op lt="Printer">Printer(|logLevel|, |args|[, |options|])</h3>
381381

382-
The printer operation is implementation-defined. It accepts a log level indicating severity, a List
383-
of arguments to print, and an optional object of implementation-specific formatting options.
382+
The printer operation is <a>implementation-defined</a>. It accepts a log level indicating severity,
383+
a List of arguments to print, and an optional object of implementation-specific formatting options.
384384
Elements appearing in |args| will be one of the following:
385385

386386
- JavaScript objects of any type.
@@ -389,7 +389,7 @@ Elements appearing in |args| will be one of the following:
389389
<a>optimally useful formatting</a> applied.
390390

391391
If the |options| object is passed, and is not undefined or null, implementations may use |options|
392-
to apply implementation-specific formatting to the elements in |args|.
392+
to apply <a>implementation-defined</a> formatting to the elements in |args|.
393393

394394
How the implementation prints |args| is up to the implementation, but implementations should
395395
separate the objects by a space or something similar, as that has become a developer expectation.
@@ -401,8 +401,8 @@ Printer should appear only within the last <a>group</a> on the appropriate <a>gr
401401
<a>group stack</a> is not empty, or elsewhere in the console otherwise.
402402

403403
If the console is not open when the printer operation is called, implementations should buffer
404-
messages to show them in the future up to an implementation-chosen limit (typically on the order of
405-
at least 100).
404+
messages to show them in the future up to an <a>implementation-defined</a> limit (typically on the
405+
order of at least 100).
406406

407407
<h4 id="loglevel-severity">Indicating |logLevel| severity</h4>
408408

@@ -474,8 +474,9 @@ providing special behavior for each function, as in the following examples:
474474

475475
<h4 id="printer-ux-innovation">Printer user experience innovation</h4>
476476

477-
Since <a abstract-op>Printer</a> is implementation-defined, it is common to see UX innovations in
478-
its implementations. The following is a non-exhaustive list of potential UX enhancements:
477+
Since <a abstract-op>Printer</a> is <a>implementation-defined</a>, it is common to see UX
478+
innovations in its implementations. The following is a non-exhaustive list of potential UX
479+
enhancements:
479480

480481
<ul>
481482
<li>
@@ -506,13 +507,13 @@ its implementations. The following is a non-exhaustive list of potential UX enha
506507

507508
Typically objects will be printed in a format that is suitable for their context. This section
508509
describes common ways in which objects are formatted to be most useful in their context. It should
509-
be noted that the formatting described in this section is applied to implementation-specific object
510-
representations that will eventually be passed into <a abstract-op>Printer</a>, where the actual
511-
side effect of formatting will be seen.
510+
be noted that the formatting described in this section is applied to <a>implementation-defined</a>
511+
object representations that will eventually be passed into <a abstract-op>Printer</a>, where the
512+
actual side effect of formatting will be seen.
512513

513514
An object with <dfn>generic JavaScript object formatting</dfn> is a potentially expandable
514515
representation of a generic JavaScript object. An object with
515-
<dfn>optimally useful formatting</dfn> is an implementation-specific, potentially-interactive
516+
<dfn>optimally useful formatting</dfn> is an <a>implementation-defined</a>, potentially-interactive
516517
representation of an object judged to be maximally useful and informative.
517518

518519
<h4 id="nodejs-printer">Example printer in Node.js</h4>
@@ -554,7 +555,7 @@ representation of an object judged to be maximally useful and informative.
554555
To <dfn export>report a warning to the console</dfn> given a generic description of a warning
555556
|description|, implementations must run these steps:
556557

557-
1. Let |warning| be an implementation-defined string derived from |description|.
558+
1. Let |warning| be an <a>implementation-defined</a> string derived from |description|.
558559
1. Perform <a abstract-op>Printer</a>("reportWarning", « |warning| »).
559560

560561
<h2 id="acks" class="no-num">Acknowledgments</h2>

0 commit comments

Comments
 (0)