Merge pull request #673 from Mathics3/complete_doc_url_bunch_e

Another bunch of urls  in docstrings

Author: rocky

mathics/builtin/attributes.py

@@ -14,17 +14,17 @@
 """
 
 
-from mathics.builtin.base import Predefined, Builtin
+from mathics.builtin.base import Builtin, Predefined
 from mathics.core.assignment import get_symbol_list
 from mathics.core.atoms import String
 from mathics.core.attributes import (
-    attributes_bitset_to_list,
-    attribute_string_to_number,
     A_HOLD_ALL,
     A_HOLD_FIRST,
     A_LISTABLE,
     A_LOCKED,
     A_PROTECTED,
+    attribute_string_to_number,
+    attributes_bitset_to_list,
 )
 from mathics.core.expression import Expression
 from mathics.core.list import ListExpression
@@ -237,7 +237,7 @@ class HoldAll(Predefined):
     <dl>
       <dt>'HoldAll'
       <dd>is an attribute specifying that all arguments of a \
-        function should be left unevaluated.
+          function should be left unevaluated.
     </dl>
 
     >> Attributes[Function]
@@ -256,8 +256,8 @@ class HoldAllComplete(Predefined):
     <dl>
       <dt>'HoldAllComplete'
       <dd>is an attribute that includes the effects of 'HoldAll' and \
-        'SequenceHold', and also protects the function from being \
-        affected by the upvalues of any arguments.
+         'SequenceHold', and also protects the function from being \
+          affected by the upvalues of any arguments.
     </dl>
 
     'HoldAllComplete' even prevents upvalues from being used, and \
@@ -271,7 +271,8 @@ class HoldAllComplete(Predefined):
      = f[Sequence[a, b]]
     """
 
-    summary_text = "attribute for symbols that keep unevaluated all their elements, and discards upvalues"
+    summary_text = "attribute for symbols that keep unevaluated all \
+                    their elements, and discards upvalues"
 
 
 class HoldFirst(Predefined):
@@ -283,14 +284,15 @@ class HoldFirst(Predefined):
     <dl>
       <dt>'HoldFirst'
       <dd>is an attribute specifying that the first argument of a \
-        function should be left unevaluated.
+         function should be left unevaluated.
     </dl>
 
     >> Attributes[Set]
      = {HoldFirst, Protected, SequenceHold}
     """
 
-    summary_text = "attribute for symbols that keep unevaluated their first element"
+    summary_text = "attribute for symbols that keep unevaluated their \
+                    first element"
 
 
 class HoldRest(Predefined):
@@ -379,7 +381,7 @@ class NHoldAll(Predefined):
     <dl>
       <dt>'NHoldAll'
       <dd>is an attribute that protects all arguments of a \
-        function from numeric evaluation.
+         function from numeric evaluation.
     </dl>
 
     >> N[f[2, 3]]

mathics/builtin/binary/io.py

@@ -4,29 +4,26 @@
 """
 
 import math
-import mpmath
 import struct
-import sympy
-
 from itertools import chain
 
+import mpmath
+import sympy
+
 from mathics.builtin.base import Builtin
 from mathics.core.atoms import Complex, Integer, MachineReal, Real, String
 from mathics.core.convert.expression import to_expression, to_mathics_list
 from mathics.core.convert.mpmath import from_mpmath
 from mathics.core.expression import Expression
-
-from mathics.core.systemsymbols import (
-    SymbolDirectedInfinity,
-    SymbolIndeterminate,
-)
-
 from mathics.core.number import dps
 from mathics.core.read import SymbolEndOfFile
 from mathics.core.streams import stream_manager
 from mathics.core.symbols import Symbol
-from mathics.core.systemsymbols import SymbolComplex
-
+from mathics.core.systemsymbols import (
+    SymbolComplex,
+    SymbolDirectedInfinity,
+    SymbolIndeterminate,
+)
 from mathics.eval.nevaluator import eval_N
 
 SymbolBinaryWrite = Symbol("BinaryWrite")
@@ -362,12 +359,18 @@ def _UnsignedInteger128_writer(s, x):
 
 class BinaryRead(Builtin):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/BinaryRead.html</url>
+
     <dl>
-    <dt>'BinaryRead[$stream$]'
+      <dt>'BinaryRead[$stream$]'
       <dd>reads one byte from the stream as an integer from 0 to 255.
-    <dt>'BinaryRead[$stream$, $type$]'
+
+      <dt>'BinaryRead[$stream$, $type$]'
       <dd>reads one object of specified type from the stream.
-    <dt>'BinaryRead[$stream$, {$type1$, $type2$, ...}]'
+
+      <dt>'BinaryRead[$stream$, {$type1$, $type2$, ...}]'
       <dd>reads a sequence of objects of specified types.
     </dl>
 
@@ -603,11 +606,11 @@ class BinaryRead(Builtin):
         "bfmt": "The stream `1` has been opened with BinaryFormat -> False and cannot be used with binary data.",
     }
 
-    def apply_empty(self, name, n, evaluation):
+    def eval_empty(self, name, n, evaluation):
         "BinaryRead[InputStream[name_, n_Integer]]"
-        return self.apply(name, n, None, evaluation)
+        return self.eval(name, n, None, evaluation)
 
-    def apply(self, name, n, typ, evaluation):
+    def eval(self, name, n, typ, evaluation):
         "BinaryRead[InputStream[name_, n_Integer], typ_]"
 
         channel = to_expression("InputStream", name, n)
@@ -657,6 +660,10 @@ def apply(self, name, n, typ, evaluation):
 
 class BinaryWrite(Builtin):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/BinaryWrite.html</url>
+
     <dl>
       <dt>'BinaryWrite[$channel$, $b$]'
       <dd>writes a single byte given as an integer from 0 to 255.
@@ -894,11 +901,11 @@ class BinaryWrite(Builtin):
 
     writers = _BinaryFormat.get_writers()
 
-    def apply_notype(self, name, n, b, evaluation):
+    def eval_notype(self, name, n, b, evaluation):
         "BinaryWrite[OutputStream[name_, n_], b_]"
-        return self.apply(name, n, b, None, evaluation)
+        return self.eval(name, n, b, None, evaluation)
 
-    def apply(self, name, n, b, typ, evaluation):
+    def eval(self, name, n, b, typ, evaluation):
         "BinaryWrite[OutputStream[name_, n_], b_, typ_]"
 
         channel = to_expression("OutputStream", name, n)

mathics/builtin/binary/system.py

@@ -11,10 +11,15 @@
 
 class ByteOrdering(Predefined):
     """
+    <url>
+    :WMA link:
+    https://reference.wolfram.com/language/ref/ByteOrdering.html</url>
+
     <dl>
       <dt>'ByteOrdering'
-      <dd> is an option for BinaryRead, BinaryWrite, and related functions that specifies what ordering
-    of bytes should be assumed for your computer system..
+      <dd> is an option for BinaryRead, BinaryWrite, and related functions \
+      that specifies what ordering of bytes should be assumed for your \
+      computer system..
     </dl>
 
     X> ByteOrdering
@@ -31,16 +36,17 @@ class ByteOrdering(Predefined):
 
 class ByteOrdering_(Predefined):
     """
-    <dl>
-      <dt>'$ByteOrdering'
-      <dd>returns the native ordering of bytes in binary data on your computer system.
-    </dl>
+    <url>:WMA link:https://reference.wolfram.com/language/ref/$ByteOrdering.html</url>
+        <dl>
+          <dt>'$ByteOrdering'
+          <dd>returns the native ordering of bytes in binary data on your computer system.
+        </dl>
 
-    X> $ByteOrdering
-     = 1
+        X> $ByteOrdering
+         = 1
 
-    #> $ByteOrdering == -1 || $ByteOrdering == 1
-     = True
+        #> $ByteOrdering == -1 || $ByteOrdering == 1
+         = True
     """
 
     name = "$ByteOrdering"

mathics/builtin/binary/types.py

@@ -9,6 +9,8 @@
 
 class Byte(Builtin):
     """
+    <url>:WMA link:https://reference.wolfram.com/language/ref/Byte.html</url>
+
     <dl>
       <dt>'Byte'
       <dd>is a data type for 'Read'.