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.

Sign up for GitHub

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

Jump to bottom

[Markdown] [Web/API] Fix some unconvertible tables #8588

Merged
merged 3 commits into from
Sep 4, 2021
Merged

[Markdown] [Web/API] Fix some unconvertible tables #8588

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b4963d
Fix tables to be Markdownable
wbamberg Sep 3, 2021
5e1c4ec
Fix indentation
wbamberg Sep 3, 2021
e0b22df
Address review comments
wbamberg Sep 4, 2021
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
3 changes: 1 addition & 2 deletions files/en-us/web/api/audioprocessingevent/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,8 +64,7 @@ <h2 id="Properties">Properties</h2>
<tr>
<td><code>outputBuffer</code> {{ReadOnlyInline}}</td>
<td>{{domxref("AudioBuffer")}}</td>
<td>
<p>The buffer where the output audio data should be written. The number of channels is defined as a parameter, <code>numberOfOutputChannels</code>, of the factory method {{domxref("BaseAudioContext/createScriptProcessor", "AudioContext.createScriptProcessor()")}}. Note the returned <code>AudioBuffer</code> is only valid in the scope of the <code>onaudioprocess</code> function.</p>
<td>The buffer where the output audio data should be written. The number of channels is defined as a parameter, <code>numberOfOutputChannels</code>, of the factory method {{domxref("BaseAudioContext/createScriptProcessor", "AudioContext.createScriptProcessor()")}}. Note the returned <code>AudioBuffer</code> is only valid in the scope of the <code>onaudioprocess</code> function.
</td>
</tr>
</tbody>
Expand Down
8 changes: 2 additions & 6 deletions files/en-us/web/api/backgroundfetchmanager/fetch/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,11 @@ <h3 id="Exceptions">Exceptions</h3>
<tbody>
<tr>
<td><code>AbortError</code></td>
<td>
<p>Indicates the fetch was aborted.</p>
</td>
<td>Indicates the fetch was aborted.</td>
</tr>
<tr>
<td><code>NotAllowedError</code></td>
<td>
<p>Indicates that user permission has not been granted to make background fetches.</p>
</td>
<td>Indicates that user permission has not been granted to make background fetches.</td>
</tr>
</tbody>
</table>
Expand Down
21 changes: 5 additions & 16 deletions files/en-us/web/api/cache/add/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,24 +51,13 @@ <h3 id="Return_value">Return value</h3>

<h3 id="Exceptions">Exceptions</h3>

<table class="standard-table">
<thead>
<tr>
<th scope="col"><strong>Exception</strong></th>
<th scope="col"><strong>Happens when</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>TypeError</code></td>
<td>
<dl>
<dt><code>TypeError</code></dt>
<dd>
<p>The URL scheme is not <code>http</code> or <code>https</code>.</p>

<p>The Response status is not in the 200 range (i.e., not a successful response.) This occurs if the request does not return successfully, but also if the request is a <em>cross-origin no-cors</em> request (in which case the reported status is always 0.)</p>
</td>
</tr>
</tbody>
</table>
</dd>
</dl>

<h2 id="Examples">Examples</h2>

Expand Down
28 changes: 7 additions & 21 deletions files/en-us/web/api/cache/addall/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,27 +49,13 @@ <h3 id="Return_value">Return value</h3>

<h3 id="Exceptions">Exceptions</h3>

<table class="standard-table">
<thead>
<tr>
<th scope="col"><strong>Exception</strong></th>
<th scope="col"><strong>Happens when</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td><code>TypeError</code></td>
<td>
<p>The URL scheme is not <code>http</code> or <code>https</code>.</p>

<p>The Response status is not in the 200 range (i.e., not a successful response.)
This occurs if the request does not return successfully, but also if the request
is a <em>cross-origin no-cors</em> request (in which case the reported status is
always 0.)</p>
</td>
</tr>
</tbody>
</table>
<dl>
<dt><code>TypeError</code></dt>
<dd>
<p>The URL scheme is not <code>http</code> or <code>https</code>.</p>
<p>The Response status is not in the 200 range (i.e., not a successful response.) This occurs if the request does not return successfully, but also if the request is a <em>cross-origin no-cors</em> request (in which case the reported status is always 0.)</p>
</dd>
</dl>

<h2 id="Examples">Examples</h2>

Expand Down
34 changes: 21 additions & 13 deletions files/en-us/web/api/canvasrenderingcontext2d/drawwindow/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,10 @@

<p>This API cannot be used by Web content. It is synchronous, and as such can't capture
cross-origin (out of process) iframes with Fission.  If you're using it from an
extension, you should switch to {{WebExtAPIRef('tabs.captureTab')}} to capture the
tab's image as a <a class="external" href="/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
rel="external">data: url</a> and then render the captured image onto canvas using
{{domxref("CanvasRenderingContext2D.drawImage")}}. If you're writing chrome code,
extension, you should switch to {{WebExtAPIRef('tabs.captureTab')}} to capture the
tab's image as a <a class="external" href="/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs"
rel="external">data: url</a> and then render the captured image onto canvas using
{{domxref("CanvasRenderingContext2D.drawImage")}}. If you're writing chrome code,
you probably want <a
href="https://searchfox.org/mozilla-central/rev/9b282b34b5/dom/chrome-webidl/WindowGlobalActors.webidl#81-98">WindowGlobalParent.drawSnapshot</a>
from the parent process.</p>
Expand Down Expand Up @@ -64,13 +64,16 @@ <h3 id="Parameters">Parameters</h3>
</dd>
<dt><code>flags</code> {{optional_inline}}</dt>
<dd>Used to better control the <code>drawWindow</code> call. Flags can be ORed together.

<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Value</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>DRAWWINDOW_DRAW_CARET</code></td>
<td><code>0x01</code></td>
Expand All @@ -79,8 +82,10 @@ <h3 id="Parameters">Parameters</h3>
<tr>
<td><code>DRAWWINDOW_DO_NOT_FLUSH</code></td>
<td><code>0x02</code></td>
<td>Do not flush pending layout notifications that could otherwise be batched
up.</td>
<td>
Do not flush pending layout notifications that could otherwise be
batched up.
</td>
</tr>
<tr>
<td><code>DRAWWINDOW_DRAW_VIEW</code></td>
Expand All @@ -90,9 +95,12 @@ <h3 id="Parameters">Parameters</h3>
<tr>
<td><code>DRAWWINDOW_USE_WIDGET_LAYERS</code></td>
<td><code>0x08</code></td>
<td>Use the widget layer manager if available. This means hardware acceleration
may be used, but it might actually be slower or lower quality than normal. It
will, however, more accurately reflect the pixels rendered to the screen.</td>
<td>
Use the widget layer manager if available. This means hardware
acceleration may be used, but it might actually be slower or lower
quality than normal. It will, however, more accurately reflect the
pixels rendered to the screen.
</td>
</tr>
<tr>
<td><code>DRAWWINDOW_ASYNC_DECODE_IMAGES</code></td>
Expand Down
14 changes: 7 additions & 7 deletions files/en-us/web/api/closeevent/code/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,14 @@ <h3>Value</h3>
<p>A status code. As detailed in the following table, sourced from <a href="https://www.iana.org/assignments/websocket/websocket.xml#close-code-number">the IANA website</a>:</p>

<table class="standard-table">
<thead>
<tr>
<th>Status code</th>
<th>Name</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="header">Status code</td>
<td class="header">Name</td>
<td class="header">Description</td>
</tr>
<tr>
<td><code>0</code>–<code>999</code></td>
<td></td>
Expand Down Expand Up @@ -149,5 +151,3 @@ <h2 id="Specifications">Specifications</h2>
<h2 id="Browser_compatibility">Browser compatibility</h2>

<p>{{Compat}}</p>


9 changes: 5 additions & 4 deletions files/en-us/web/api/cssomstring/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,12 @@
<h4 id="Implementation_differences">Implementation differences</h4>

<table class="standard-table">
<thead>
<tr>
<th>Browser</th>
<th>DOMString or USVString for CSSOMString</th>
</tr>
<tbody>
<tr>
<td class="header">Browser</td>
<td class="header">DOMString or USVString for CSSOMString</td>
</tr>
<tr>
<td>Firefox (Gecko)</td>
<td>USVString</td>
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/web/api/cssprimitivevalue/getfloatvalue/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ <h3 id="Parameters">Parameters</h3>
<dd>An <code>unsigned short</code> representing the code for the unit type, in which the
value should be returned. Valid values are:
<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CSS_CM</code></td>
<td>The value is a {{cssxref("&lt;length&gt;")}} in centimeters.</td>
Expand Down
10 changes: 6 additions & 4 deletions files/en-us/web/api/cssprimitivevalue/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ <h2 id="Properties">Properties</h2>
<dt>{{DOMxRef("CSSPrimitiveValue.primitiveType")}} {{readonlyInline}}</dt>
<dd>An <code>unsigned short</code> representing the type of the value. Possible values are:
<table class="standard-table">
<thead>
<tr>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
</tr>
<tr>
<td><code>CSS_ATTR</code></td>
<td>The value is an {{CSSxRef("attr()")}} function. The value can be obtained by using the <code>getStringValue()</code> method.</td>
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/web/api/cssprimitivevalue/primitivetype/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,11 +36,13 @@ <h3 id="Value">Value</h3>
</p>

<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CSS_ATTR</code></td>
<td>The value is an {{cssxref("attr()")}} function. The value can be obtained by
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/web/api/cssprimitivevalue/setfloatvalue/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ <h3 id="Parameters">Parameters</h3>
<dd>An <code>unsigned short</code> representing the code for the unit type, in which the
value should be returned. Valid values are:
<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CSS_CM</code></td>
<td>The value is a {{cssxref("&lt;length&gt;")}} in centimeters.</td>
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/web/api/cssprimitivevalue/setstringvalue/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ <h3 id="Parameters">Parameters</h3>
<dd>An <code>unsigned short</code> representing the type of the value. Possible values
are:
<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CSS_ATTR</code></td>
<td>The value is an {{cssxref("attr()")}} function.</td>
Expand Down
8 changes: 5 additions & 3 deletions files/en-us/web/api/cssvalue/cssvaluetype/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,13 @@ <h3 id="Value">Value</h3>
Possible values are:</p>

<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>CSS_CUSTOM</code></td>
<td>The value is a custom value.</td>
Expand Down
10 changes: 6 additions & 4 deletions files/en-us/web/api/cssvalue/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,13 @@ <h2 id="Properties">Properties</h2>
<dt>{{DOMxRef("CSSValue.cssValueType")}}{{ReadOnlyInline}}</dt>
<dd>An <code>unsigned short</code> representing a code defining the type of the value. Possible values are:
<table class="standard-table">
<thead>
<tr>
<th>Constant</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="header">Constant</td>
<td class="header">Description</td>
</tr>
<tr>
<td><code>CSS_CUSTOM</code></td>
<td>The value is a custom value.</td>
Expand Down
13 changes: 5 additions & 8 deletions files/en-us/web/api/document/createnodeiterator/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,9 +33,9 @@ <h3 id="Values">Values</h3>
<table class="standard-table">
<thead>
<tr>
<th class="header" scope="col">Constant</th>
<th class="header" scope="col">Numerical value</th>
<th class="header" scope="col">Description</th>
<th>Constant</th>
<th>Numerical value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
Expand All @@ -47,14 +47,11 @@ <h3 id="Values">Values</h3>
<tr>
<td><code>NodeFilter.SHOW_ATTRIBUTE</code> {{deprecated_inline}}</td>
<td><code>2</code></td>
<td>
<p>Shows attribute {{ domxref("Attr") }} nodes.</p>

<p>This is meaningful only when creating a {{ domxref("TreeWalker") }} with an
<td>Shows attribute {{ domxref("Attr") }} nodes. This is meaningful only when creating a {{ domxref("TreeWalker") }} with an
{{ domxref("Attr") }} node as its root. In this case, it means that the
attribute node will appear in the first position of the iteration or
traversal. Since attributes are never children of other nodes, they do not
appear when traversing over the document tree.</p>
appear when traversing over the document tree.
</td>
</tr>
<tr>
Expand Down
14 changes: 8 additions & 6 deletions files/en-us/web/api/document/createtreewalker/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,14 @@ <h3 id="Parameters">Parameters</h3>
It is a convenient way of filtering for certain types of node. It defaults to
<code>0xFFFFFFFF</code> representing the <code>SHOW_ALL</code> constant.
<table class="standard-table">
<tbody>
<thead>
<tr>
<td class="header">Constant</td>
<td class="header">Numerical value</td>
<td class="header">Description</td>
<th>Constant</th>
<th>Numerical value</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>NodeFilter.SHOW_ALL</code></td>
<td><code>-1</code> (that is the max value of <code>unsigned long</code>)</td>
Expand Down Expand Up @@ -127,8 +129,8 @@ <h3 id="Return_value">Return value</h3>

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

<p>The following example goes through all nodes in the body,
filters out any non nodes that aren't elements (with the `NodeFilter.SHOW_ELEMENT` value),
<p>The following example goes through all nodes in the body,
filters out any non nodes that aren't elements (with the `NodeFilter.SHOW_ELEMENT` value),
marks each remaining node as acceptable (The <code>acceptNode()</code> method could make
a different decision.), and then makes use of tree walker iterator
that is created to advance through the nodes (now all elements) and push them into an
Expand Down
Loading