Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Markdown] [Web/API] Fix notes and warnings that omit spaces #8545

Merged
merged 2 commits into from
Sep 1, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ <h3 id="Value">Value</h3>
<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>

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

<h2 id="Example">Example</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
invoked to do so.</p>

<div class="notecard note">
<p><strong>Note:</strong> Currently, audio data blocks are always 128 frames
<p><strong>Note:</strong> Currently, audio data blocks are always 128 frames
long—that is, they contain 128 32-bit floating-point samples for each of the inputs'
channels. However, plans are already in place to revise the specification to allow the
size of the audio blocks to be changed depending on circumstances (for example, if the
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cache/addall/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
retrieval become keys to the stored response operations. </p>

<div class="note">
<p><strong>Note:</strong> <code>addAll()</code> will overwrite any key/value pairs
<p><strong>Note:</strong> <code>addAll()</code> will overwrite any key/value pairs
previously stored in the cache that match the request, but will fail if a
resulting <code>put()</code> operation would overwrite a previous cache entry stored
by the same <code>addAll()</code> method.</p>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ <h4 id="Result">Result</h4>
<h3 id="Data_loss_due_to_browser_optimization">Data loss due to browser optimization</h3>

<div class="notecard warning">
<p><strong>Warning:</strong> Due to the lossy nature of converting to and from premultiplied alpha color values,
<p><strong>Warning:</strong> Due to the lossy nature of converting to and from premultiplied alpha color values,
pixels that have just been set using <code>putImageData()</code> might be returned to
an equivalent <code>getImageData()</code> as different values.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/console/profileend/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<p>{{APIRef("Console API")}}{{Non-standard_header}}</p>

<div class="notecard warning">
<p><strong>Warning:</strong> Calling this API immediately after console.profile() can cause it to not work. To
<p><strong>Warning:</strong> Calling this API immediately after console.profile() can cause it to not work. To
work around this, call it in a setTimeout with at least 5ms delay. See
{{bug(1240249)}}.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cookiestore/delete/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ <h3 id="Parameters">Parameters</h3>
</dl>

<div class="notecard note">
<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>
<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>
</div>

<h3 id="Returns">Return value</h3>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cookiestore/get/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ <h3 id="Parameters">Parameters</h3>
</dl>

<div class="notecard note">
<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>
<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>
</div>

<h3 id="Returns">Return value</h3>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/cookiestore/getall/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ <h3 id="Parameters">Parameters</h3>
</dl>

<div class="notecard note">
<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>
<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>
</div>

<h3 id="Returns">Return value</h3>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/css_font_loading_api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
<p>The CSS Font Loading API provides events and interfaces for dynamically loading font resources.</p>

<div class="notecard note">
<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>
<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>
</div>

<h2 id="Interfaces">Interfaces</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/document/keypress_event/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
<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>

<div class="notecard warning">
<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>
<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>
</div>

<table class="properties">
Expand Down
5 changes: 2 additions & 3 deletions files/en-us/web/api/domparser/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,8 @@
{{domxref("XMLHttpRequest.response", "response")}} property.</p>

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

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/element/scrollleft/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
scroll towards the end of the content.</p>

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

Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/element/setpointercapture/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ <h3 id="Exceptions">Exceptions</h3>
<tr>
<td><code>NotFoundError</code></td>
<td><code><var>pointerId</var></code> does not match any of the active pointers.
<div class="note"><p><strong>Note:</strong> Firefox versions <em>before</em> Firefox
<div class="note"><p><strong>Note:</strong> Firefox versions <em>before</em> Firefox
82 incorrectly throw <code>InvalidPointerId</code>.</p></div>
</td>
</tr>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/eventsource/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
<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>

<div class="notecard warning">
<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>
<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>
</div>

<h2 id="Constructor">Constructor</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/file/getasbinary/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<p>{{APIRef("File API")}}{{non-standard_header}}{{deprecated_header}}</p>

<div class="note notebox">
<p><strong>Note:</strong>This method was removed from Firefox 7.0 and onward.</p>
<p><strong>Note:</strong> This method was removed from Firefox 7.0 and onward.</p>
</div>

<h2 id="Summary">Summary</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/file/getastext/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<div>{{APIRef("File API")}}{{non-standard_header}}{{deprecated_header}}</div>

<div class="note notebox">
<p><strong>Note:</strong>This method was removed from Firefox 7.0 and onward.</p>
<p><strong>Note:</strong> This method was removed from Firefox 7.0 and onward.</p>
</div>

<h2 id="Summary">Summary</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/filereadersync/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
<p>{{AvailableInWorkers}}</p>

<div class="notecard warning">
<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>
<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>
</div>

<h2 id="Properties">Properties</h2>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
certain keys.</p>

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ <h2 id="link">Dragging Links</h2>
<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>

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

<p>For example, this sample <code>text/uri-list</code> data contains two links and a comment:</p>
Expand All @@ -55,7 +55,7 @@ <h2 id="link">Dragging Links</h2>
<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>

<div class="notecard warning">
<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>
<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>
</div>

<pre class="brush: js">var url = event.dataTransfer.getData("URL");
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmlimageelement/hspace/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ <h2 id="Usage_notes">Usage notes</h2>
pixels.</p>

<div class="notecard warning">
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
{{cssxref("margin")}} property and its longhand forms to establish margins around
an <code>&lt;img&gt;</code>.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmlimageelement/ismap/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
This may only be used on images located within an {{HTMLElement("a")}} element.</p>

<div class="notecard note">
<p><strong>Note:</strong> For accessibility reasons, you should generally avoid using
<p><strong>Note:</strong> For accessibility reasons, you should generally avoid using
server-side image maps, as they require the use of a mouse. Use a <a
href="/en-US/docs/Learn/HTML/Howto/Add_a_hit_map_on_top_of_an_image">client-side
image map</a> instead.</p>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmlimageelement/name/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ <h3 id="Value">Value</h3>
<p>A {{domxref("DOMString")}} providing a name by which the image can be referenced.</p>

<div class="notecard warning">
<p><strong>Warning:</strong> This property is deprecated and is only in the
<p><strong>Warning:</strong> This property is deprecated and is only in the
specification still for backward compatibility purposes. Since it functions
identically to {{htmlattrxref("id")}}, you can and should use it instead.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/htmlimageelement/vspace/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ <h2 id="Usage_notes">Usage notes</h2>
pixels.</p>

<div class="notecard warning">
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
<p><strong>Warning:</strong> This property is obsolete. You should instead use the CSS
{{cssxref("margin")}} property and its longhand forms to establish margins around
an <code>&lt;img&gt;</code>.</p>
</div>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/idbcursor/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
<h2 id="Properties">Properties</h2>

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

<dl>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/idbenvironmentsync/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
<p>{{APIRef("IndexedDB")}} {{ draft() }}</p>

<div class="notecard warning">
<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>
<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>
</div>

<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>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1307,7 +1307,7 @@ <h3 id="JavaScript_Content">JavaScript Content</h3>
<p>{{ LiveSampleLink('Full_IndexedDB_example', "Test the online live demo") }}</p>

<div class="notecard note">
<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>
<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>
</div>

<h2 id="See_also">See also</h2>
Expand Down
2 changes: 1 addition & 1 deletion files/en-us/web/api/keyboardevent/charcode/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
pressed during a {{Event("keypress")}} event.</p>

<div class="notecard warning">
<p><strong>Warning:</strong> Do not use this property, as it is deprecated. Instead, get the
<p><strong>Warning:</strong> Do not use this property, as it is deprecated. Instead, get the
Unicode value of the character using the {{domxref("KeyboardEvent.key", "key")}}
property.</p>
</div>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@
<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>

<div class="notecard warning">
<p><strong>Warning:</strong></p>

<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>
<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>

<p>This specification is more or less abandoned, failing to get significant traction.</p>
</div>
Expand Down
Loading