Deploy: a52285e

Author: array-api-bot

draft/API_specification/generated/array_api.info.__array_namespace_info__.html

@@ -473,14 +473,16 @@ <h1 id="api-specification-generated-array-api-info-array-namespace-info--page-ro
 <dt class="sig sig-object py" id="array_api.info.__array_namespace_info__">
 <span class="sig-name descname"><span class="pre">__array_namespace_info__</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Info</span></span></span><a class="headerlink" href="#array_api.info.__array_namespace_info__" title="Link to this definition">¶</a></dt>
 <dd><p>Returns a namespace with Array API namespace inspection utilities.</p>
-<p>See <a class="reference internal" href="../inspection.html#inspection"><span class="std std-ref">Inspection</span></a> for a list of inspection APIs.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>out</strong> (<em>Info</em>) – An object containing Array API namespace inspection utilities.</p>
+<dd class="field-odd"><p><strong>out</strong> (<em>Info</em>) – an object containing Array API namespace inspection utilities.</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>
-<p>The returned object may be either a namespace or a class, so long as an Array API user can access inspection utilities as follows:</p>
+<ul class="simple">
+<li><p>See <a class="reference internal" href="../inspection.html#inspection"><span class="std std-ref">Inspection</span></a> for a list of inspection APIs.</p></li>
+<li><p>The returned object <strong>may</strong> be either a namespace or a class, as long as an Array API user can access inspection utilities as follows:</p></li>
+</ul>
 <div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">info</span> <span class="o">=</span> <span class="n">xp</span><span class="o">.</span><span class="n">__array_namespace_info__</span><span class="p">()</span>
 <span class="n">info</span><span class="o">.</span><span class="n">capabilities</span><span class="p">()</span>
 <span class="n">info</span><span class="o">.</span><span class="n">devices</span><span class="p">()</span>

draft/API_specification/generated/array_api.info.capabilities.html

@@ -473,15 +473,14 @@ <h1 id="api-specification-generated-array-api-info-capabilities--page-root">capa
 <dt class="sig sig-object py" id="array_api.info.capabilities">
 <span class="sig-name descname"><span class="pre">capabilities</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Capabilities</span></span></span><a class="headerlink" href="#array_api.info.capabilities" title="Link to this definition">¶</a></dt>
 <dd><p>Returns a dictionary of array library capabilities.</p>
-<p>The dictionary must contain the following keys:</p>
-<ul class="simple">
-<li><p><code class="code docutils literal notranslate"><span class="pre">"boolean</span> <span class="pre">indexing"</span></code>: boolean indicating whether an array library supports boolean indexing. If a conforming implementation fully supports boolean indexing in compliance with this specification (see <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a>), the corresponding dictionary value must be <code class="docutils literal notranslate"><span class="pre">True</span></code>; otherwise, the value must be <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">"data-dependent</span> <span class="pre">shapes"</span></code>: boolean indicating whether an array library supports data-dependent output shapes. If a conforming implementation fully supports all APIs included in this specification (excluding boolean indexing) which have data-dependent output shapes, as explicitly demarcated throughout the specification, the corresponding dictionary value must be <code class="docutils literal notranslate"><span class="pre">True</span></code>; otherwise, the value must be <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
-<li><p><code class="code docutils literal notranslate"><span class="pre">"max</span> <span class="pre">dimensions"</span></code>: maximum number of supported dimensions. If a conforming implementation supports arrays having an arbitrary number of dimensions (potentially infinite), the corresponding dictionary value must be <code class="docutils literal notranslate"><span class="pre">None</span></code>; otherwise, the value must be a finite integer.</p></li>
-</ul>
 <dl class="field-list simple">
 <dt class="field-odd">Returns<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>out</strong> (<em>Capabilities</em>) – a dictionary of array library capabilities.</p>
+<dd class="field-odd"><p><strong>out</strong> (<em>Capabilities</em>) – a dictionary of array library capabilities. The returned dictionary <strong>must</strong> contain the following keys:</p>
+<ul class="simple">
+<li><p><code class="code docutils literal notranslate"><span class="pre">"boolean</span> <span class="pre">indexing"</span></code>: boolean indicating whether an array library supports boolean indexing. If a conforming implementation fully supports boolean indexing in compliance with this specification (see <a class="reference internal" href="../indexing.html#indexing"><span class="std std-ref">Indexing</span></a>), the corresponding dictionary value <strong>must</strong> be <code class="docutils literal notranslate"><span class="pre">True</span></code>; otherwise, the value <strong>must</strong> be <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">"data-dependent</span> <span class="pre">shapes"</span></code>: boolean indicating whether an array library supports data-dependent output shapes. If a conforming implementation fully supports all APIs included in this specification (excluding boolean indexing) which have data-dependent output shapes, as explicitly demarcated throughout the specification, the corresponding dictionary value <strong>must</strong> be <code class="docutils literal notranslate"><span class="pre">True</span></code>; otherwise, the value <strong>must</strong> be <code class="docutils literal notranslate"><span class="pre">False</span></code>.</p></li>
+<li><p><code class="code docutils literal notranslate"><span class="pre">"max</span> <span class="pre">dimensions"</span></code>: maximum number of supported dimensions. If a conforming implementation supports arrays having an arbitrary number of dimensions (potentially infinite), the corresponding dictionary value <strong>must</strong> be <code class="docutils literal notranslate"><span class="pre">None</span></code>; otherwise, the value <strong>must</strong> be a finite integer.</p></li>
+</ul>
 </dd>
 </dl>
 <p class="rubric">Notes</p>

draft/API_specification/generated/array_api.info.default_dtypes.html

@@ -473,28 +473,25 @@ <h1 id="api-specification-generated-array-api-info-default-dtypes--page-root">de
 <dt class="sig sig-object py" id="array_api.info.default_dtypes">
 <span class="sig-name descname"><span class="pre">default_dtypes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">device</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">device</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">DefaultDataTypes</span></span></span><a class="headerlink" href="#array_api.info.default_dtypes" title="Link to this definition">¶</a></dt>
 <dd><p>Returns a dictionary containing default data types.</p>
-<p>The dictionary must have the following keys:</p>
+<dl class="field-list">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>device</strong> (<em>Optional</em><em>[</em><em>device</em><em>]</em>) – device for which to return default data types. If <code class="docutils literal notranslate"><span class="pre">device</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the returned data types <strong>must</strong> be the default data types for the current device; otherwise, the returned data types <strong>must</strong> be default data types specific to the specified device. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
+</dd>
+<dt class="field-even">Returns<span class="colon">:</span></dt>
+<dd class="field-even"><p><strong>out</strong> (<em>DefaultDataTypes</em>) – a dictionary containing the default data type for respective data type kinds. The returned dictionary <strong>must</strong> have the following keys:</p>
 <ul class="simple">
 <li><p><code class="code docutils literal notranslate"><span class="pre">"real</span> <span class="pre">floating"</span></code>: default real floating-point data type.</p></li>
 <li><p><code class="code docutils literal notranslate"><span class="pre">"complex</span> <span class="pre">floating"</span></code>: default complex floating-point data type.</p></li>
 <li><p><code class="code docutils literal notranslate"><span class="pre">"integral"</span></code>: default integral data type.</p></li>
 <li><p><code class="code docutils literal notranslate"><span class="pre">"indexing"</span></code>: default array index data type.</p></li>
 </ul>
-<p>Dictionary values must be the corresponding data type object.</p>
-<dl class="field-list simple">
-<dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>device</strong> (<em>Optional</em><em>[</em><em>device</em><em>]</em>) – <p>device for which to return default data types. If <code class="docutils literal notranslate"><span class="pre">device</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, the returned data types must be the default data types for the current device; otherwise, the returned data types must be default data types specific to the specified device. Default: <code class="docutils literal notranslate"><span class="pre">None</span></code>.</p>
-<div class="admonition note">
-<p class="admonition-title">Note</p>
-<p>Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When <code class="docutils literal notranslate"><span class="pre">device</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, libraries supporting a device context should return the default data types for the current device. For libraries without a context manager or supporting only a single device, those libraries should return the default data types for the default device.</p>
-</div>
-</p>
-</dd>
-<dt class="field-even">Returns<span class="colon">:</span></dt>
-<dd class="field-even"><p><strong>out</strong> (<em>DefaultDataTypes</em>) – a dictionary containing the default data type for respective data type kinds.</p>
+<p>Dictionary values <strong>must</strong> be the corresponding data type object.</p>
 </dd>
 </dl>
 <p class="rubric">Notes</p>
+<ul class="simple">
+<li><p>Some array libraries have the concept of a device context manager, allowing library consumers to manage the current device context. When <code class="docutils literal notranslate"><span class="pre">device</span></code> is <code class="docutils literal notranslate"><span class="pre">None</span></code>, libraries supporting a device context <strong>must</strong> return the default data types for the current device. For libraries without a context manager or supporting only a single device, those libraries <strong>must</strong> return the default data types for the default device.</p></li>
+</ul>
 </dd></dl>
 </section>
 

draft/API_specification/generated/array_api.info.devices.html

@@ -479,7 +479,9 @@ <h1 id="api-specification-generated-array-api-info-devices--page-root">devices<a
 </dd>
 </dl>
 <p class="rubric">Notes</p>
-<p>Each device object (see <a class="reference internal" href="../../design_topics/device_support.html#device-support"><span class="std std-ref">Device support</span></a>) in the list of returned devices must be an object which can be provided as a valid keyword-argument to array creation functions.</p>
+<ul class="simple">
+<li><p>Each device object (see <a class="reference internal" href="../../design_topics/device_support.html#device-support"><span class="std std-ref">Device support</span></a>) in the list of returned devices <strong>must</strong> be an object which can be provided as a valid keyword-argument to array creation functions.</p></li>
+</ul>
 <p class="rubric">Notes</p>
 </dd></dl>
 </section>