Skip to content

Commit 19032ca

Browse files
authored
[Markdown] [Web/API] Fix notes and warnings that omit spaces (#8545)
1 parent a6566ab commit 19032ca

File tree

54 files changed

+58
-65
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+58
-65
lines changed

files/en-us/web/api/analysernode/smoothingtimeconstant/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ <h3 id="Value">Value</h3>
2929
<p>In technical terms, we apply a <a href="https://webaudio.github.io/web-audio-api/#blackman-window">Blackman window</a> and smooth the values over time. The default value is good enough for most cases.</p>
3030

3131
<div class="note">
32-
<p><strong>Note:</strong>  If a value outside the range 0–1 is set, an <code>INDEX_SIZE_ERR</code> exception is thrown.</p>
32+
<p><strong>Note:</strong> If a value outside the range 0–1 is set, an <code>INDEX_SIZE_ERR</code> exception is thrown.</p>
3333
</div>
3434

3535
<h2 id="Example">Example</h2>

files/en-us/web/api/audioworkletprocessor/process/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
invoked to do so.</p>
3131

3232
<div class="notecard note">
33-
<p><strong>Note:</strong> Currently, audio data blocks are always 128 frames
33+
<p><strong>Note:</strong> Currently, audio data blocks are always 128 frames
3434
long—that is, they contain 128 32-bit floating-point samples for each of the inputs'
3535
channels. However, plans are already in place to revise the specification to allow the
3636
size of the audio blocks to be changed depending on circumstances (for example, if the

files/en-us/web/api/cache/addall/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
retrieval become keys to the stored response operations. </p>
2323

2424
<div class="note">
25-
<p><strong>Note:</strong> <code>addAll()</code> will overwrite any key/value pairs
25+
<p><strong>Note:</strong> <code>addAll()</code> will overwrite any key/value pairs
2626
previously stored in the cache that match the request, but will fail if a
2727
resulting <code>put()</code> operation would overwrite a previous cache entry stored
2828
by the same <code>addAll()</code> method.</p>

files/en-us/web/api/canvasrenderingcontext2d/putimagedata/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h4 id="Result">Result</h4>
121121
<h3 id="Data_loss_due_to_browser_optimization">Data loss due to browser optimization</h3>
122122

123123
<div class="notecard warning">
124-
<p><strong>Warning:</strong> Due to the lossy nature of converting to and from premultiplied alpha color values,
124+
<p><strong>Warning:</strong> Due to the lossy nature of converting to and from premultiplied alpha color values,
125125
pixels that have just been set using <code>putImageData()</code> might be returned to
126126
an equivalent <code>getImageData()</code> as different values.</p>
127127
</div>

files/en-us/web/api/console/profileend/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<p>{{APIRef("Console API")}}{{Non-standard_header}}</p>
1717

1818
<div class="notecard warning">
19-
<p><strong>Warning:</strong> Calling this API immediately after console.profile() can cause it to not work. To
19+
<p><strong>Warning:</strong> Calling this API immediately after console.profile() can cause it to not work. To
2020
work around this, call it in a setTimeout with at least 5ms delay. See
2121
{{bug(1240249)}}.</p>
2222
</div>

files/en-us/web/api/cookiestore/delete/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ <h3 id="Parameters">Parameters</h3>
3939
</dl>
4040

4141
<div class="notecard note">
42-
<p><strong>Note:</strong>The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
42+
<p><strong>Note:</strong> The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
4343
</div>
4444

4545
<h3 id="Returns">Return value</h3>

files/en-us/web/api/cookiestore/get/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ <h3 id="Parameters">Parameters</h3>
3737
</dl>
3838

3939
<div class="notecard note">
40-
<p><strong>Note:</strong>The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
40+
<p><strong>Note:</strong> The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
4141
</div>
4242

4343
<h3 id="Returns">Return value</h3>

files/en-us/web/api/cookiestore/getall/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ <h3 id="Parameters">Parameters</h3>
3535
</dl>
3636

3737
<div class="notecard note">
38-
<p><strong>Note:</strong>The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
38+
<p><strong>Note:</strong> The <code>url</code> option enables the modification of a cookie scoped under a particular URL. Service workers can obtain cookies that would be sent to any URL under their scope. From a document you may only obtain the cookies at the current URL, so the only valid URL in a document context is the document's URL.</p>
3939
</div>
4040

4141
<h3 id="Returns">Return value</h3>

files/en-us/web/api/css_font_loading_api/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<p>The CSS Font Loading API provides events and interfaces for dynamically loading font resources.</p>
1616

1717
<div class="notecard note">
18-
<p><strong>Note:</strong> This feature is available in <a href="/en-US/docs/Web/API/Web_Workers_API">Web Workers</a> (<code>self.fonts</code> provides access to {{domxref('FontFaceSet')}}).</p>
18+
<p><strong>Note:</strong> This feature is available in <a href="/en-US/docs/Web/API/Web_Workers_API">Web Workers</a> (<code>self.fonts</code> provides access to {{domxref('FontFaceSet')}}).</p>
1919
</div>
2020

2121
<h2 id="Interfaces">Interfaces</h2>

files/en-us/web/api/document/keypress_event/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<p>Examples of keys that produce a character value are alphabetic, numeric, and punctuation keys. Examples of keys that don't produce a character value are modifier keys such as <kbd>Alt</kbd>, <kbd>Shift</kbd>, <kbd>Ctrl</kbd>, or <kbd>Meta</kbd>.</p>
1717

1818
<div class="notecard warning">
19-
<p><strong>Warning:</strong> Since this event has been deprecated, you should look to use <code><a href="/en-US/docs/Web/API/HTMLElement/beforeinput_event">beforeinput</a></code> or <code><a href="/en-US/docs/Web/API/Document/keydown_event">keydown</a></code> instead.</p>
19+
<p><strong>Warning:</strong> Since this event has been deprecated, you should look to use <code><a href="/en-US/docs/Web/API/HTMLElement/beforeinput_event">beforeinput</a></code> or <code><a href="/en-US/docs/Web/API/Document/keydown_event">keydown</a></code> instead.</p>
2020
</div>
2121

2222
<table class="properties">

files/en-us/web/api/domparser/index.html

+2-3
Original file line numberDiff line numberDiff line change
@@ -31,9 +31,8 @@
3131
{{domxref("XMLHttpRequest.response", "response")}} property.</p>
3232

3333
<div class="note notecard">
34-
<p>
35-
<strong>Note:</strong> Be aware that <a href="/en-US/docs/Web/HTML/Block-level_elements">block-level elements</a>
36-
like <code>&lt;p&gt;</code> will be automatically closed if another
34+
<p><strong>Note:</strong> Be aware that <a href="/en-US/docs/Web/HTML/Block-level_elements">block-level elements</a>
35+
like <code>&lt;p&gt;</code> will be automatically closed if another
3736
block-level element is nested inside and therefore parsed before the closing <code>&lt;/p&gt;</code> tag.</p>
3837
</div>
3938

files/en-us/web/api/element/scrollleft/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
scroll towards the end of the content.</p>
2020

2121
<div class="notecard warning">
22-
<p><strong>Warning:</strong> On systems using display scaling, <code>scrollLeft</code> may give you a decimal
22+
<p><strong>Warning:</strong> On systems using display scaling, <code>scrollLeft</code> may give you a decimal
2323
value.</p>
2424
</div>
2525

files/en-us/web/api/element/setpointercapture/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ <h3 id="Exceptions">Exceptions</h3>
6565
<tr>
6666
<td><code>NotFoundError</code></td>
6767
<td><code><var>pointerId</var></code> does not match any of the active pointers.
68-
<div class="note"><p><strong>Note:</strong> Firefox versions <em>before</em> Firefox
68+
<div class="note"><p><strong>Note:</strong> Firefox versions <em>before</em> Firefox
6969
82 incorrectly throw <code>InvalidPointerId</code>.</p></div>
7070
</td>
7171
</tr>

files/en-us/web/api/eventsource/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<p>Unlike <a href="/en-US/docs/Web/API/WebSockets_API">WebSockets</a>, server-sent events are unidirectional; that is, data messages are delivered in one direction, from the server to the client (such as a user's web browser). That makes them an excellent choice when there's no need to send data from the client to the server in message form. For example, <code>EventSource</code> is a useful approach for handling things like social media status updates, news feeds, or delivering data into a <a href="/en-US/docs/Learn/JavaScript/Client-side_web_APIs/Client-side_storage">client-side storage</a> mechanism like <a href="/en-US/docs/Web/API/IndexedDB_API">IndexedDB</a> or <a href="/en-US/docs/Web/API/Web_Storage_API">web storage</a>.</p>
2424

2525
<div class="notecard warning">
26-
<p><strong>Warning:</strong> When <strong>not used over HTTP/2</strong>, SSE suffers from a limitation to the maximum number of open connections, which can be specially painful when opening various tabs as the limit is <em>per browser</em> and set to a very low number (6). The issue has been marked as "Won't fix" in <a href="https://bugs.chromium.org/p/chromium/issues/detail?id=275955" rel="noreferrer">Chrome</a> and <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=906896" rel="noreferrer">Firefox</a>. This limit is per browser + domain, so that means that you can open 6 SSE connections across all of the tabs to <code>www.example1.com</code> and another 6 SSE connections to <code>www.example2.com.</code> (from <a href="https://stackoverflow.com/a/5326159/1905229">Stackoverflow</a>). When using HTTP/2, the maximum number of simultaneous <em>HTTP streams</em> is negotiated between the server and the client (defaults to 100).</p>
26+
<p><strong>Warning:</strong> When <strong>not used over HTTP/2</strong>, SSE suffers from a limitation to the maximum number of open connections, which can be specially painful when opening various tabs as the limit is <em>per browser</em> and set to a very low number (6). The issue has been marked as "Won't fix" in <a href="https://bugs.chromium.org/p/chromium/issues/detail?id=275955" rel="noreferrer">Chrome</a> and <a href="https://bugzilla.mozilla.org/show_bug.cgi?id=906896" rel="noreferrer">Firefox</a>. This limit is per browser + domain, so that means that you can open 6 SSE connections across all of the tabs to <code>www.example1.com</code> and another 6 SSE connections to <code>www.example2.com.</code> (from <a href="https://stackoverflow.com/a/5326159/1905229">Stackoverflow</a>). When using HTTP/2, the maximum number of simultaneous <em>HTTP streams</em> is negotiated between the server and the client (defaults to 100).</p>
2727
</div>
2828

2929
<h2 id="Constructor">Constructor</h2>

files/en-us/web/api/file/getasbinary/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<p>{{APIRef("File API")}}{{non-standard_header}}{{deprecated_header}}</p>
1414

1515
<div class="note notebox">
16-
<p><strong>Note:</strong>This method was removed from Firefox 7.0 and onward.</p>
16+
<p><strong>Note:</strong> This method was removed from Firefox 7.0 and onward.</p>
1717
</div>
1818

1919
<h2 id="Summary">Summary</h2>

files/en-us/web/api/file/getastext/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<div>{{APIRef("File API")}}{{non-standard_header}}{{deprecated_header}}</div>
1414

1515
<div class="note notebox">
16-
<p><strong>Note:</strong>This method was removed from Firefox 7.0 and onward.</p>
16+
<p><strong>Note:</strong> This method was removed from Firefox 7.0 and onward.</p>
1717
</div>
1818

1919
<h2 id="Summary">Summary</h2>

files/en-us/web/api/filereadersync/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
<p>{{AvailableInWorkers}}</p>
1414

1515
<div class="notecard warning">
16-
<p><strong>Warning:</strong> This interface is <strong>only available</strong> in <a href="/en-US/docs/Web/API/Worker">workers</a> as it enables synchronous I/O that could potentially block.</p>
16+
<p><strong>Warning:</strong> This interface is <strong>only available</strong> in <a href="/en-US/docs/Web/API/Worker">workers</a> as it enables synchronous I/O that could potentially block.</p>
1717
</div>
1818

1919
<h2 id="Properties">Properties</h2>

files/en-us/web/api/globaleventhandlers/onkeypress/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
certain keys.</p>
2323

2424
<div class="notecard warning">
25-
<p><strong>Warning:</strong> The <code>onkeypress</code> event handler has been deprecated. You may want to use
25+
<p><strong>Warning:</strong> The <code>onkeypress</code> event handler has been deprecated. You may want to use
2626
{{domxref("GlobalEventHandlers.onkeydown", "onkeydown")}} instead.</p>
2727
</div>
2828

files/en-us/web/api/html_drag_and_drop_api/recommended_drag_types/index.html

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ <h2 id="link">Dragging Links</h2>
4242
<p>To drag multiple links, separate each link inside the <code>text/uri-list</code> data with a CRLF linebreak. Lines that begin with a number sign (<code>#</code>) are comments, and should not be considered URLs. You can use comments to indicate the purpose of a URL, the title associated with a URL, or other data.</p>
4343

4444
<div class="notecard warning">
45-
<p><strong>Warning:</strong> The <code>text/plain</code> fallback for multiple links should include all URLs, but no comments.</p>
45+
<p><strong>Warning:</strong> The <code>text/plain</code> fallback for multiple links should include all URLs, but no comments.</p>
4646
</div>
4747

4848
<p>For example, this sample <code>text/uri-list</code> data contains two links and a comment:</p>
@@ -55,7 +55,7 @@ <h2 id="link">Dragging Links</h2>
5555
<p>When retrieving a dropped link, ensure you handle when multiple links are dragged, including any comments. For convenience, the special type <code>URL</code> may be used to refer to the first valid link within data for the <code>text/uri-list</code> type.</p>
5656

5757
<div class="notecard warning">
58-
<p><strong>Warning:</strong> Do not add data with the <code>URL</code> type — attempting to do so will set the value of the <code>text/uri-list</code> type instead.</p>
58+
<p><strong>Warning:</strong> Do not add data with the <code>URL</code> type — attempting to do so will set the value of the <code>text/uri-list</code> type instead.</p>
5959
</div>
6060

6161
<pre class="brush: js">var url = event.dataTransfer.getData("URL");

files/en-us/web/api/htmlimageelement/hspace/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ <h2 id="Usage_notes">Usage notes</h2>
4949
pixels.</p>
5050

5151
<div class="notecard warning">
52-
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
52+
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
5353
{{cssxref("margin")}} property and its longhand forms to establish margins around
5454
an <code>&lt;img&gt;</code>.</p>
5555
</div>

files/en-us/web/api/htmlimageelement/ismap/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
This may only be used on images located within an {{HTMLElement("a")}} element.</p>
2121

2222
<div class="notecard note">
23-
<p><strong>Note:</strong> For accessibility reasons, you should generally avoid using
23+
<p><strong>Note:</strong> For accessibility reasons, you should generally avoid using
2424
server-side image maps, as they require the use of a mouse. Use a <a
2525
href="/en-US/docs/Learn/HTML/Howto/Add_a_hit_map_on_top_of_an_image">client-side
2626
image map</a> instead.</p>

files/en-us/web/api/htmlimageelement/name/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ <h3 id="Value">Value</h3>
3232
<p>A {{domxref("DOMString")}} providing a name by which the image can be referenced.</p>
3333

3434
<div class="notecard warning">
35-
<p><strong>Warning:</strong> This property is deprecated and is only in the
35+
<p><strong>Warning:</strong> This property is deprecated and is only in the
3636
specification still for backward compatibility purposes. Since it functions
3737
identically to {{htmlattrxref("id")}}, you can and should use it instead.</p>
3838
</div>

files/en-us/web/api/htmlimageelement/vspace/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ <h2 id="Usage_notes">Usage notes</h2>
4545
pixels.</p>
4646

4747
<div class="notecard warning">
48-
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
48+
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
4949
{{cssxref("margin")}} property and its longhand forms to establish margins around
5050
an <code>&lt;img&gt;</code>.</p>
5151
</div>

files/en-us/web/api/idbcursor/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
<h2 id="Properties">Properties</h2>
2828

2929
<div class="notecard note">
30-
<p><strong>Note:</strong> {{domxref("IDBCursorWithValue")}} is an <strong><code>IDBCursor</code></strong> interface with an additional <strong><code>value</code></strong> property.</p>
30+
<p><strong>Note:</strong> {{domxref("IDBCursorWithValue")}} is an <strong><code>IDBCursor</code></strong> interface with an additional <strong><code>value</code></strong> property.</p>
3131
</div>
3232

3333
<dl>

files/en-us/web/api/idbenvironmentsync/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
<p>{{APIRef("IndexedDB")}} {{ draft() }}</p>
1313

1414
<div class="notecard warning">
15-
<p><strong>Warning:</strong> The synchronous version of the IndexedDB API was originally intended for use only with <a href="/en-US/docs/Web/API/Web_Workers_API/Using_web_workers">Web Workers</a>, and was eventually removed from the spec because its need was questionable. It may however be reintroduced in the future if there is enough demand from web developers.</p>
15+
<p><strong>Warning:</strong> The synchronous version of the IndexedDB API was originally intended for use only with <a href="/en-US/docs/Web/API/Web_Workers_API/Using_web_workers">Web Workers</a>, and was eventually removed from the spec because its need was questionable. It may however be reintroduced in the future if there is enough demand from web developers.</p>
1616
</div>
1717

1818
<p>The {{ unimplemented_inline() }} <code>IDBEnvironmentSync</code> interface of the <a href="/en-US/docs/Web/API/IndexedDB_API">IndexedDB API</a> will be implemented by <a href="/en-US/docs/Web/API/Worker">worker</a> objects.</p>

files/en-us/web/api/indexeddb_api/using_indexeddb/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -1307,7 +1307,7 @@ <h3 id="JavaScript_Content">JavaScript Content</h3>
13071307
<p>{{ LiveSampleLink('Full_IndexedDB_example', "Test the online live demo") }}</p>
13081308

13091309
<div class="notecard note">
1310-
<p><strong>Note:</strong> <code>window.indexedDB.open()</code> is asynchronous; the method will finish running long before the <code>success</code> event is fired. This means that a function (e.g. <code>openDb()</code>) that calls <code>open()</code> and <code>onsuccess</code> will return before the <code>onsuccess</code> handler has run. This issue is also true of other request methods such as <code>transaction()</code> and <code>get()</code>.</p>
1310+
<p><strong>Note:</strong> <code>window.indexedDB.open()</code> is asynchronous; the method will finish running long before the <code>success</code> event is fired. This means that a function (e.g. <code>openDb()</code>) that calls <code>open()</code> and <code>onsuccess</code> will return before the <code>onsuccess</code> handler has run. This issue is also true of other request methods such as <code>transaction()</code> and <code>get()</code>.</p>
13111311
</div>
13121312

13131313
<h2 id="See_also">See also</h2>

files/en-us/web/api/keyboardevent/charcode/index.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
pressed during a {{Event("keypress")}} event.</p>
1818

1919
<div class="notecard warning">
20-
<p><strong>Warning:</strong> Do not use this property, as it is deprecated. Instead, get the
20+
<p><strong>Warning:</strong> Do not use this property, as it is deprecated. Instead, get the
2121
Unicode value of the character using the {{domxref("KeyboardEvent.key", "key")}}
2222
property.</p>
2323
</div>

files/en-us/web/api/localfilesystemsync/requestfilesystemsync/index.html

+1-3
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,7 @@
88
<p>The <strong><code>requestFileSystemSync</code></strong> method of the <code>LocalFileSystemSync</code> interface of the <a href="/en-US/docs/Web/API/File_and_Directory_Entries_API/Introduction">File System API</a> creates a new a sandboxed file system. It is intended to be used with <a href="/en-US/docs/Web/API/Worker"> WebWorkers</a>. The methods are implemented by <a href="/en-US/docs/Web/API/Worker">worker</a> objects.</p>
99

1010
<div class="notecard warning">
11-
<p><strong>Warning:</strong></p>
12-
13-
<p>This document was last updated on March 2, 2012 and follows the <a href="https://www.w3.org/TR/file-system-api/">W3C Specifications (Working Draft)</a> drafted on April 19, 2011.</p>
11+
<p><strong>Warning:</strong> This document was last updated on March 2, 2012 and follows the <a href="https://www.w3.org/TR/file-system-api/">W3C Specifications (Working Draft)</a> drafted on April 19, 2011.</p>
1412

1513
<p>This specification is more or less abandoned, failing to get significant traction.</p>
1614
</div>

0 commit comments

Comments
 (0)