Merge pull request #674 from Mathics3/complete_doc_url_bunch_f

another bunch of docstring urls (almost done)

Author: rocky

mathics/builtin/compilation.py

@@ -36,6 +36,8 @@
 
 class Compile(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Compile.html</url>
+
     <dl>
       <dt>'Compile[{$x1$, $x2$, ...}, $expr$]'
       <dd>Compiles $expr$ assuming each $xi$ is a $Real$ number.
@@ -182,7 +184,9 @@ def atom_to_boxes(self, f, evaluation):
 
 
 class CompiledFunction(Builtin):
-    """'
+    """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/CompiledFunction.html</url>
+
     <dl>
       <dt>'CompiledFunction[$args$...]'
       <dd>represents compiled code for evaluating a compiled function.

mathics/builtin/compress.py

@@ -10,8 +10,12 @@
 
 class Compress(Builtin):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/Compress.html</url>
+
     <dl>
-    <dt>'Compress[$expr$]'
+      <dt>'Compress[$expr$]'
       <dd>gives a compressed string representation of $expr$.
     </dl>
 
@@ -25,7 +29,7 @@ class Compress(Builtin):
     }
     summary_text = "compress an expression"
 
-    def apply(self, expr, evaluation, options):
+    def eval(self, expr, evaluation, options):
         "Compress[expr_, OptionsPattern[Compress]]"
         if isinstance(expr, String):
             string = '"' + expr.value + '"'
@@ -45,6 +49,10 @@ def apply(self, expr, evaluation, options):
 
 class Uncompress(Builtin):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/Uncompress.html</url>
+
     <dl>
     <dt>'Uncompress["$string$"]'
       <dd>recovers an expression from a string generated by 'Compress'.
@@ -63,7 +71,7 @@ class Uncompress(Builtin):
 
     summary_text = "recover a compressed expression"
 
-    def apply(self, string, evaluation):
+    def eval(self, string, evaluation):
         "Uncompress[string_String]"
         string = string.get_string_value()  # .encode("utf-8")
         string = base64.b64decode(string)

mathics/builtin/graphics.py

@@ -185,6 +185,9 @@ def _extract_graphics(graphics, format, evaluation):
 
 class Show(Builtin):
     """
+
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Show.html</url>
+
     <dl>
       <dt>'Show[$graphics$, $options$]'
       <dd>shows a list of graphics with the specified options added.
@@ -224,6 +227,8 @@ def eval(self, graphics, evaluation, options):
 
 class Graphics(Builtin):
     r"""
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Graphics.html</url>
+
     <dl>
       <dt>'Graphics[$primitives$, $options$]'
       <dd>represents a graphic.
@@ -395,9 +400,14 @@ class _Thickness(_Size):
 
 class AbsoluteThickness(_Thickness):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/AbsoluteThickness.html</url>
+
     <dl>
       <dt>'AbsoluteThickness[$p$]'
-      <dd>sets the line thickness for subsequent graphics primitives to $p$ points.
+      <dd>sets the line thickness for subsequent graphics primitives to $p$ \
+          points.
     </dl>
 
     >> Graphics[Table[{AbsoluteThickness[t], Line[{{20 t, 10}, {20 t, 80}}], Text[ToString[t]<>"pt", {20 t, 0}]}, {t, 0, 10}]]
@@ -412,6 +422,8 @@ def get_thickness(self):
 
 class Point(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Point.html</url>
+
     <dl>
       <dt>'Point[{$point_1$, $point_2$ ...}]'
       <dd>represents the point primitive.
@@ -441,6 +453,8 @@ class Point(Builtin):
 
 class PointSize(_Size):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/PointSize.html</url>
+
     <dl>
       <dt>'PointSize[$t$]'
       <dd>sets the diameter of points to $t$, which is relative to the overall width.
@@ -468,6 +482,9 @@ def get_absolute_size(self):
 # is kind of  wrong.
 class Line(Builtin):
     """
+
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Line.html</url>
+
     <dl>
       <dt>'Line[{$point_1$, $point_2$ ...}]'
       <dd>represents the line primitive.
@@ -520,6 +537,11 @@ def path(max_degree, p):
 
 class FilledCurve(Builtin):
     """
+
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/FilledCurve.html</url>
+
     <dl>
       <dt>'FilledCurve[{$segment1$, $segment2$ ...}]'
       <dd>represents a filled curve.
@@ -537,6 +559,8 @@ class FilledCurve(Builtin):
 
 class Polygon(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Polygon.html</url>
+
     <dl>
       <dt>'Polygon[{$point_1$, $point_2$ ...}]'
       <dd>represents the filled polygon primitive.
@@ -564,6 +588,11 @@ class Polygon(Builtin):
 
 class RegularPolygon(Builtin):
     """
+
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/RegularPolygon.html</url>
+
     <dl>
       <dt>'RegularPolygon[$n$]'
       <dd>gives the regular polygon with $n$ edges.
@@ -587,6 +616,10 @@ class RegularPolygon(Builtin):
 
 class Arrow(Builtin):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/Arrow.html</url>
+
     <dl>
       <dt>'Arrow[{$p1$, $p2$}]'
       <dd>represents a line from $p1$ to $p2$ that ends with an arrow at $p2$.
@@ -623,6 +656,11 @@ class Arrow(Builtin):
 
 class Arrowheads(_GraphicsDirective):
     """
+
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/Arrowheads.html</url>
+
     <dl>
       <dt>'Arrowheads[$s$]'
       <dd>specifies that Arrow[] draws one arrow of size $s$ (relative to width of image, defaults to 0.04).
@@ -1150,6 +1188,8 @@ def set_size(
 
 class Circle(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Circle.html</url>
+
     <dl>
       <dt>'Circle[{$cx$, $cy$}, $r$]'
       <dd>draws a circle with center '($cx$, $cy$)' and radius $r$.
@@ -1180,6 +1220,8 @@ class Circle(Builtin):
 
 class Disk(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Disk.html</url>
+
     <dl>
       <dt>'Disk[{$cx$, $cy$}, $r$]'
       <dd>fills a circle with center '($cx$, $cy$)' and radius $r$.
@@ -1216,6 +1258,8 @@ class Disk(Builtin):
 
 class Directive(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Directive.html</url>
+
     <dl>
       <dt> 'Directive'[$g_1$, $g_2$, ...]
       <dd> represents a single graphics directive composed of the directives $g_1$, $g_2$, ...
@@ -1228,6 +1272,8 @@ class Directive(Builtin):
 
 class EdgeForm(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/EdgeForm.html</url>
+
     <dl>
       <dt> 'EdgeForm[$g$]'
       <dd> is a graphics directive that specifies that edges of filled graphics objects are to be drawn using the graphics directive or list of directives $g$.
@@ -1244,6 +1290,8 @@ class EdgeForm(Builtin):
 
 class FaceForm(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/FaceForm.html</url>
+
     <dl>
       <dt> 'FaceForm[$g$]'
       <dd> is a graphics directive that specifies that faces of filled graphics objects are to be drawn using the graphics directive or list of directives $ g$.
@@ -1255,6 +1303,8 @@ class FaceForm(Builtin):
 
 class FontColor(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/FontColor.html</url>
+
     <dl>
       <dt>'FontColor'
       <dd>is an option for Style to set the font color.
@@ -1266,6 +1316,8 @@ class FontColor(Builtin):
 
 class Inset(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Inset.html</url>
+
     <dl>
       <dt>'Text[$obj$]'
       <dd>represents an object $obj$ inset in a graphic.
@@ -1284,6 +1336,8 @@ class Inset(Builtin):
 
 class Large(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Large.html</url>
+
     <dl>
       <dt>'ImageSize' -> 'Large'
       <dd>produces a large image.
@@ -1295,6 +1349,8 @@ class Large(Builtin):
 
 class Medium(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Medium.html</url>
+
     <dl>
       <dt>'ImageSize' -> 'Medium'
       <dd>produces a medium-sized image.
@@ -1306,6 +1362,8 @@ class Medium(Builtin):
 
 class Offset(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Offset.html</url>
+
     <dl>
       <dt>'Offset[{$dx$, $dy$}, $position$]'
       <dd>gives the position of a graphical object obtained by starting at the specified $position$ and then moving by absolute offset {$dx$,$dy$}.
@@ -1317,6 +1375,8 @@ class Offset(Builtin):
 
 class Rectangle(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Rectangle.html</url>
+
     <dl>
       <dt>'Rectangle[{$xmin$, $ymin$}]'
       <dd>represents a unit square with bottom-left corner at {$xmin$, $ymin$}.
@@ -1338,6 +1398,8 @@ class Rectangle(Builtin):
 
 class Small(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Small.html</url>
+
     <dl>
       <dt>'ImageSize' -> 'Small'
       <dd>produces a small image.
@@ -1349,6 +1411,8 @@ class Small(Builtin):
 
 class Text(Inset):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Text.html</url>
+
     <dl>
       <dt>'Text["$text$", {$x$, $y$}]'
       <dd>draws $text$ centered on position '{$x$, $y$}'.
@@ -1366,6 +1430,8 @@ class Text(Inset):
 
 class Thick(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Thick.html</url>
+
     <dl>
       <dt>'Thick'
       <dd>sets the line width for subsequent graphics primitives to 2pt.
@@ -1378,6 +1444,8 @@ class Thick(Builtin):
 
 class Thin(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Thin.html</url>
+
     <dl>
       <dt>'Thin'
       <dd>sets the line width for subsequent graphics primitives to 0.5pt.
@@ -1390,6 +1458,8 @@ class Thin(Builtin):
 
 class Thickness(_Thickness):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Thickness.html</url>
+
     <dl>
       <dt>'Thickness[$t$]'
       <dd>sets the line thickness for subsequent graphics primitives to $t$ times the size of the plot area.
@@ -1407,6 +1477,8 @@ def get_thickness(self):
 
 class Tiny(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Tiny.html</url>
+
     <dl>
       <dt>'ImageSize' -> 'Tiny'
       <dd>produces a tiny image.

mathics/builtin/inout.py

@@ -30,6 +30,8 @@
 
 class Echo_(Predefined):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Echo_.html</url>
+
     <dl>
       <dt>'$Echo'
       <dd>gives a list of files and pipes to which all input is echoed.
@@ -45,6 +47,8 @@ class Echo_(Predefined):
 
 class Print(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Print.html</url>
+
     <dl>
       <dt>'Print[$expr$, ...]'
       <dd>prints each $expr$ in string form.

mathics/builtin/manipulate.py

@@ -241,6 +241,8 @@ def display_data(self, result):
 
 class Manipulate(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Manipulate.html</url>
+
     <dl>
     <dt>'Manipulate[$expr1$, {$u$, $u_min$, $u_max$}]'
         <dd>interactively compute and display an expression with different values of $u$.