Skip to content

Commit 749d15e

Browse files
committed
Update documentation
1 parent 1240cb0 commit 749d15e

110 files changed

Lines changed: 485 additions & 633 deletions

File tree

Some content is hidden

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

2d_ellipse-1.pdf

0 Bytes
Binary file not shown.

2d_ellipse-2.pdf

0 Bytes
Binary file not shown.

2d_ellipse.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -555,7 +555,7 @@ <h1>2D ellipse<a class="headerlink" href="#d-ellipse" title="Permalink to this h
555555

556556
<div role="contentinfo">
557557
<p>&#169; Copyright 2020-, Peter Corke..
558-
<span class="lastupdated">Last updated on 26-Jun-2024.
558+
<span class="lastupdated">Last updated on 23-Jul-2024.
559559
</span></p>
560560
</div>
561561

2d_line.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ <h1>2D line<a class="headerlink" href="#d-line" title="Permalink to this headlin
302302

303303
<div role="contentinfo">
304304
<p>&#169; Copyright 2020-, Peter Corke..
305-
<span class="lastupdated">Last updated on 26-Jun-2024.
305+
<span class="lastupdated">Last updated on 23-Jul-2024.
306306
</span></p>
307307
</div>
308308

2d_linesegment.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ <h1>2D line segment<a class="headerlink" href="#d-line-segment" title="Permalink
122122

123123
<div role="contentinfo">
124124
<p>&#169; Copyright 2020-, Peter Corke..
125-
<span class="lastupdated">Last updated on 26-Jun-2024.
125+
<span class="lastupdated">Last updated on 23-Jul-2024.
126126
</span></p>
127127
</div>
128128

2d_orient_SO2-1.pdf

0 Bytes
Binary file not shown.

2d_orient_SO2.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
121121
<dd class="field-odd"><p><strong>n</strong> (<em>int</em><em>, </em><em>optional</em>) – Number of values, defaults to 1</p>
122122
</dd>
123123
<dt class="field-even">Return type</dt>
124-
<dd class="field-even"><p>Self</p>
124+
<dd class="field-even"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">Self</span></code></p>
125125
</dd>
126126
<dt class="field-odd">Returns</dt>
127127
<dd class="field-odd"><p>pose instance with <code class="docutils literal notranslate"><span class="pre">n</span></code> default values</p>
@@ -997,8 +997,8 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
997997
<dl class="field-list simple">
998998
<dt class="field-odd">Parameters</dt>
999999
<dd class="field-odd"><ul class="simple">
1000-
<li><p><strong>arg</strong> (<em>Any</em>) – initial value</p></li>
1001-
<li><p><strong>convertfrom</strong> (<em>Tuple</em>) – list of classes to accept and convert from</p></li>
1000+
<li><p><strong>arg</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Any</span></code>) – initial value</p></li>
1001+
<li><p><strong>convertfrom</strong> (<code class="xref py py-data docutils literal notranslate"><span class="pre">Tuple</span></code>) – list of classes to accept and convert from</p></li>
10021002
<li><p><strong>check</strong> (<em>bool</em>) – check value is valid, defaults to True</p></li>
10031003
</ul>
10041004
</dd>
@@ -1038,7 +1038,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
10381038
</div>
10391039
<dl class="field-list simple">
10401040
<dt class="field-odd">Return type</dt>
1041-
<dd class="field-odd"><p>bool</p>
1041+
<dd class="field-odd"><p><code class="xref py py-class docutils literal notranslate"><span class="pre">bool</span></code></p>
10421042
</dd>
10431043
</dl>
10441044
</dd></dl>
@@ -1809,7 +1809,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
18091809
<dd class="field-odd"><p><a class="reference internal" href="#spatialmath.pose2d.SO2.printline" title="spatialmath.pose2d.SO2.printline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">printline()</span></code></a> <a class="reference internal" href="#spatialmath.pose2d.SO2.strline" title="spatialmath.pose2d.SO2.strline"><code class="xref py py-meth docutils literal notranslate"><span class="pre">strline()</span></code></a></p>
18101810
</dd>
18111811
<dt class="field-even">Return type</dt>
1812-
<dd class="field-even"><p>None</p>
1812+
<dd class="field-even"><p><code class="xref py py-obj docutils literal notranslate"><span class="pre">None</span></code></p>
18131813
</dd>
18141814
</dl>
18151815
</dd></dl>
@@ -2167,7 +2167,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
21672167

21682168
<dl class="py property">
21692169
<dt class="sig sig-object py" id="spatialmath.pose2d.SO2.A">
2170-
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><span class="pre">NDArray</span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
2170+
<em class="property"><span class="pre">property</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">A</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">Union</span><span class="p"><span class="pre">[</span></span><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.ndarray.html#numpy.ndarray" title="(in NumPy v2.0)"><span class="pre">numpy.ndarray</span></a><span class="p"><span class="pre">[</span></span><span class="pre">Any</span><span class="p"><span class="pre">,</span></span><span class="w"> </span><a class="reference external" href="https://numpy.org/doc/stable/reference/generated/numpy.dtype.html#numpy.dtype" title="(in NumPy v2.0)"><span class="pre">numpy.dtype</span></a><span class="p"><span class="pre">[</span></span><span class="pre">numpy.typing._generic_alias.ScalarType</span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span><span class="p"><span class="pre">]</span></span></em><a class="headerlink" href="#spatialmath.pose2d.SO2.A" title="Permalink to this definition"></a></dt>
21712171
<dd><p>Array value of an instance (BasePoseList superclass method)</p>
21722172
<dl class="field-list simple">
21732173
<dt class="field-odd">Returns</dt>
@@ -2318,7 +2318,7 @@ <h1>SO(2) matrix<a class="headerlink" href="#so-2-matrix" title="Permalink to th
23182318

23192319
<div role="contentinfo">
23202320
<p>&#169; Copyright 2020-, Peter Corke..
2321-
<span class="lastupdated">Last updated on 26-Jun-2024.
2321+
<span class="lastupdated">Last updated on 23-Jul-2024.
23222322
</span></p>
23232323
</div>
23242324

2d_polygon-1.pdf

0 Bytes
Binary file not shown.

2d_polygon-2.pdf

0 Bytes
Binary file not shown.

2d_polygon.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -537,7 +537,7 @@ <h1>2D polgon<a class="headerlink" href="#d-polgon" title="Permalink to this hea
537537

538538
<div role="contentinfo">
539539
<p>&#169; Copyright 2020-, Peter Corke..
540-
<span class="lastupdated">Last updated on 26-Jun-2024.
540+
<span class="lastupdated">Last updated on 23-Jul-2024.
541541
</span></p>
542542
</div>
543543

0 commit comments

Comments
 (0)