Skip to content

Commit 0379b87

Browse files
committed
Fix markup mistakes caught by latest bikeshed parser. (#547)
And fix a broken link.
1 parent f2f2641 commit 0379b87

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

index.bs

+11-11
Original file line numberDiff line numberDiff line change
@@ -2784,7 +2784,7 @@ As more specific information is shared,
27842784
the
27852785
[fingerprinting data](https://www.w3.org/TR/fingerprinting-guidance/)
27862786
available to sites gets larger.
2787-
There are also [other potential risks]([[PRIVACY-PRINCIPLES#threats]])
2787+
There are also [[PRIVACY-PRINCIPLES#threats|other potential risks]]
27882788
to user privacy.
27892789

27902790
If there is no way to design a less powerful API,
@@ -3634,7 +3634,7 @@ Names take meaning from:
36343634
* use (how people come to understand the name over time)
36353635
* context (the object on the left-hand side, for example)
36363636

3637-
<h3 id="naming-common-words">Use common words</h4>
3637+
<h3 id="naming-common-words">Use common words</h3>
36383638

36393639
API naming *must* be done in easily readable US English.
36403640
Keep in mind that most web developers aren't native English speakers.
@@ -3668,12 +3668,12 @@ to name this API less directly connected to its return type. [[FETCH]]
36683668

36693669
</div>
36703670

3671-
<h3 id="naming-charset">Use ASCII names</h4>
3671+
<h3 id="naming-charset">Use ASCII names</h3>
36723672

36733673
Names must adhere to the local language restrictions, for example CSS ident rules etc.
36743674
and *should* be in the [=ascii code point|ASCII range=].
36753675

3676-
<h3 id="naming-consultation">Consult others on naming</h4>
3676+
<h3 id="naming-consultation">Consult others on naming</h3>
36773677

36783678
Consult widely on names in your APIs.
36793679

@@ -3728,7 +3728,7 @@ such as an author or user,
37283728
use the generic pronoun "they", "their", etc.
37293729
For example, "A user may wish to adjust their preferences".
37303730

3731-
<h3 id="naming-future-proofing">Use future-proof names</h4>
3731+
<h3 id="naming-future-proofing">Use future-proof names</h3>
37323732

37333733
Naming should be generic and future-proof whenever possible.
37343734

@@ -3755,7 +3755,7 @@ as they were to PS/2 and ADB keyboards back then. [[UIEVENTS]]
37553755

37563756
</div>
37573757

3758-
<h3 id="naming-consistency">Name things consistently</h4>
3758+
<h3 id="naming-consistency">Name things consistently</h3>
37593759
Naming schemes should aim for consistency, to avoid confusion.
37603760

37613761
Sets of related names should agree with each other in:
@@ -3764,14 +3764,14 @@ Sets of related names should agree with each other in:
37643764
or they should all describe what is denied
37653765

37663766
<h4 id="naming-booleans" class="no-num no-toc">Boolean properties vs.
3767-
boolean-returning methods</h5>
3767+
boolean-returning methods</h4>
37683768

37693769
Boolean properties, options, or API arguments which are asking a question about
37703770
their argument *should not* be prefixed with <code>is</code>, while methods
37713771
that serve the same purpose, given that it has no side effects, *should* be
37723772
prefixed with <code>is</code> to be consistent with the rest of the platform.
37733773

3774-
<h4 id="casing-rules" class="no-num no-toc">Use casing rules consistent with existing APIs</h5>
3774+
<h4 id="casing-rules" class="no-num no-toc">Use casing rules consistent with existing APIs</h4>
37753775

37763776
Although they haven't always been uniformly followed, through the history of web platform API
37773777
design, the following rules have emerged:
@@ -3824,8 +3824,8 @@ design, the following rules have emerged:
38243824
<tr>
38253825
<th>Events</th>
38263826
<td>Lowercase, concatenated</td>
3827-
<td><code>{{canplaythrough}}<br>
3828-
<code>{{languagechange}}</td>
3827+
<td><code>{{canplaythrough}}</code><br>
3828+
<code>{{languagechange}}</code></td>
38293829
</tr>
38303830
<tr>
38313831
<th>HTML elements and attributes</th>
@@ -3886,7 +3886,7 @@ existing factory methods
38863886
under the same object, such as `document.initXXX()`.
38873887
New factory methods should not follow this convention.
38883888

3889-
<h3 id="naming-unsafe">Warn about dangerous features</h4>
3889+
<h3 id="naming-unsafe">Warn about dangerous features</h3>
38903890

38913891
Where possible, mark features that weaken
38923892
the guarantees provided to developers

0 commit comments

Comments
 (0)