Skip to content

Commit cee5cbc

Browse files
committed
Small doc updates
* Doc system doesn't understand </li> * Add docstring for mathics.builtin
1 parent df56a87 commit cee5cbc

File tree

4 files changed

+23
-18
lines changed

4 files changed

+23
-18
lines changed

mathics/builtin/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
11
# -*- coding: utf-8 -*-
2+
"""
3+
Mathics Built-in Functions and Variables.
4+
5+
Mathics has over a thousand Built-in Functions and variables, all of which are defined here.
6+
"""
27

38
import glob
49
import importlib

mathics/builtin/drawing/plot.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2283,9 +2283,9 @@ class Plot3D(_Plot3D):
22832283
22842284
Plot3D has the same options as Graphics3D, in particular:
22852285
<ul>
2286-
<li>Mesh</li>
2287-
<li>PlotPoints</li>
2288-
<li>MaxRecursion</li>
2286+
<li>Mesh
2287+
<li>PlotPoints
2288+
<li>MaxRecursion
22892289
</ul>
22902290
22912291

mathics/builtin/graphics.py

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -433,15 +433,15 @@ class Graphics(Builtin):
433433
Options include:
434434
435435
<ul>
436-
<li>Axes</li>
437-
<li>TicksStyle</li>
438-
<li>AxesStyle</li>
439-
<li>LabelStyle</li>
440-
<li>AspectRatio</li>
441-
<li>PlotRange</li>
442-
<li>PlotRangePadding</li>
443-
<li>ImageSize</li>
444-
<li>Background</li>
436+
<li>Axes
437+
<li>TicksStyle
438+
<li>AxesStyle
439+
<li>LabelStyle
440+
<li>AspectRatio
441+
<li>PlotRange
442+
<li>PlotRangePadding
443+
<li>ImageSize
444+
<li>Background
445445
</ul>
446446
447447
>> Graphics[{Blue, Line[{{0,0}, {1,1}}]}]

mathics/builtin/optiondoc.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -179,10 +179,10 @@ class PlotRange(Builtin):
179179
<dd>is an option for 'Plot' that gives the range of coordinates to include in a plot.
180180
</dl>
181181
<ul>
182-
<li>All all points are included.</li>
183-
<li>Automatic - outlying points are dropped.</li>
184-
<li>$max$ - explicit limit for each function.</li>
185-
<li>{$min$, $max$} - explicit limits for $y$ (2D), $z$ (3D), or array value.s</li>
182+
<li>All all points are included.
183+
<li>Automatic - outlying points are dropped.
184+
<li>$max$ - explicit limit for each function.
185+
<li>{$min$, $max$} - explicit limits for $y$ (2D), $z$ (3D), or array values.
186186
<li>{{$x$_$min$, $x$_$max$}, {{$y_min}, {$y_max}} - explit limits for $x$ and $y$.
187187
</ul>
188188
@@ -202,8 +202,8 @@ class TicksStyle(Builtin):
202202
</dl>
203203
204204
<ul>
205-
<li>TicksStyle gives styles for both tick marks and tick labels.</li>
206-
<li>TicksStyle can be used in both two and three-dimensional graphics.</li>
205+
<li>TicksStyle gives styles for both tick marks and tick labels.
206+
<li>TicksStyle can be used in both two and three-dimensional graphics.
207207
<li>TicksStyle->$list$ specifies the colors of each of the axes.
208208
</ul>
209209

0 commit comments

Comments
 (0)