removing the IMGPNG tag. Fix images and improve placeholders mechanis…

…m. Trailing \$
Mathics3 · Feb 3, 2025 · 408eb91 · 408eb91
1 parent fa44dfd
commit 408eb91
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 102 deletions.
diff --git a/mathics/builtin/atomic/numbers.py b/mathics/builtin/atomic/numbers.py
@@ -580,11 +580,11 @@ def eval_with_base_length_and_precision(self, n, b, length, p, evaluation):
 
 
 class MaxPrecision(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$MaxPrecision.html</url>
 
     <dl>
-      <dt>'$MaxPrecision'
+      <dt>'\$MaxPrecision'
       <dd>represents the maximum number of digits of precision permitted \
           in abitrary-precision numbers.
     </dl>
@@ -615,12 +615,12 @@ class MaxPrecision(Predefined):
 
 
 class MachineEpsilon_(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/$MachineEpsilon.html</url>
 
     <dl>
-      <dt>'$MachineEpsilon'
+      <dt>'\$MachineEpsilon'
       <dd>is the distance between '1.0' and the next \
           nearest representable machine-precision number.
     </dl>
@@ -643,11 +643,11 @@ def evaluate(self, evaluation):
 
 
 class MachinePrecision_(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$MachinePrecision.html</url>
 
     <dl>
-      <dt>'$MachinePrecision'
+      <dt>'\$MachinePrecision'
       <dd>is the number of decimal digits of precision for machine-precision numbers.
     </dl>
 
@@ -691,12 +691,12 @@ class MachinePrecision(Predefined):
 
 
 class MinPrecision(Builtin):
-    """
+    r"""
     <url>
     :WMA link:https://reference.wolfram.com/language/ref/$MinPrecision.html</url>
 
     <dl>
-      <dt>'$MinPrecision'
+      <dt>'\$MinPrecision'
       <dd>represents the minimum number of digits of precision permitted in \
           abitrary-precision numbers.
     </dl>

diff --git a/mathics/builtin/binary/system.py b/mathics/builtin/binary/system.py
@@ -29,10 +29,10 @@ class ByteOrdering(Predefined):
 
 
 class ByteOrdering_(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$ByteOrdering.html</url>
         <dl>
-          <dt>'$ByteOrdering'
+          <dt>'\$ByteOrdering'
           <dd>returns the native ordering of bytes in binary data on your computer system.
         </dl>
 

diff --git a/mathics/builtin/colors/color_operations.py b/mathics/builtin/colors/color_operations.py
@@ -253,9 +253,9 @@ class Darker(Builtin):
 
     <dl>
     <dt>'Darker'[$c$, $f$]
-        <dd>is equivalent to 'Blend[{$c$, Black}, $f$]'.
+        <dd>is equivalent to 'Blend'[{$c$, 'Black'}, $f$].
     <dt>'Darker'[$c$]
-        <dd>is equivalent to 'Darker[$c$, 1/3]'.
+        <dd>is equivalent to 'Darker'[$c$, '1/3'].
     </dl>
 
     >> Graphics[{Darker[Red], Disk[]}]
@@ -468,10 +468,10 @@ class Lighter(Builtin):
 
     <dl>
       <dt>'Lighter'[$c$, $f$]
-      <dd>is equivalent to 'Blend[{$c$, White}, $f$]'.
+      <dd>is equivalent to 'Blend'[{$c$, 'White'}, $f$].
 
       <dt>'Lighter'[$c$]
-      <dd>is equivalent to 'Lighter[$c$, 1/3]'.
+      <dd>is equivalent to 'Lighter'[$c$, '1/3'].
     </dl>
 
     >> Lighter[Orange, 1/4]

diff --git a/mathics/builtin/datentime.py b/mathics/builtin/datentime.py
@@ -977,11 +977,11 @@ def eval(
 
 
 class DateStringFormat(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$DateStringFormat.html</url>
 
     <dl>
-      <dt>'$DateStringFormat'
+      <dt>'\$DateStringFormat'
       <dd>gives the format used for dates generated by 'DateString'.
     </dl>
 
@@ -1046,13 +1046,13 @@ def eval(self, year: Integer, evaluation: Evaluation) -> ListExpression:
 
 
 class SystemTimeZone(Predefined):
-    """
+    r"""
     <url>
     :WMA link:
     https://reference.wolfram.com/language/ref/$SystemTimeZone.html</url>
 
     <dl>
-      <dt>'$SystemTimeZone'
+      <dt>'\$SystemTimeZone'
       <dd> gives the current time zone for the computer system on which Mathics is \
            being run.
     </dl>
@@ -1104,7 +1104,7 @@ class TimeConstrained(Builtin):
     Possible issues: for certain time-consuming functions (like simplify)
     which are based on sympy or other libraries, it is possible that
     the evaluation continues after the timeout. However, at the end of the \
-    evaluation, the function will return '$Aborted' and the results will not affect
+    evaluation, the function will return '\$Aborted' and the results will not affect
     the state of the Mathics3 kernel.
 
 
@@ -1155,13 +1155,13 @@ def eval_with_timeout_and_failexpr(
 
 
 class TimeZone(Predefined):
-    """
+    r"""
     <url>:Time Zone:https://en.wikipedia.org/wiki/Time_zone</url> (<url>
     :WMA:
     https://reference.wolfram.com/language/ref/$TimeZone.html</url>)
 
     <dl>
-      <dt>'$TimeZone'
+      <dt>'\$TimeZone'
       <dd> gives the current time zone to assume for dates and times.
     </dl>
 

diff --git a/mathics/builtin/directories/system_directories.py b/mathics/builtin/directories/system_directories.py
@@ -11,12 +11,12 @@
 
 
 class BaseDirectory_(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/$BaseDirectory.html</url>
 
     <dl>
-      <dt>'$BaseDirectory'
+      <dt>'\$BaseDirectory'
       <dd>returns the folder where user configurations are stored.
     </dl>
 
@@ -32,12 +32,12 @@ def evaluate(self, evaluation: Evaluation):
 
 
 class InitialDirectory(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/$InitialDirectory.html</url>
 
     <dl>
-      <dt>'$InitialDirectory'
+      <dt>'\$InitialDirectory'
       <dd>returns the directory from which \\Mathics was started.
     </dl>
 
@@ -53,12 +53,12 @@ def evaluate(self, evaluation: Evaluation):
 
 
 class InstallationDirectory(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/InstallationDirectory.html</url>
 
     <dl>
-      <dt>'$InstallationDirectory'
+      <dt>'\$InstallationDirectory'
       <dd>returns the top-level directory in which \\Mathics was installed.
     </dl>
 
@@ -76,11 +76,11 @@ def evaluate(self, evaluation):
 
 
 class RootDirectory(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$RootDirectory.html</url>
 
     <dl>
-    <dt>'$RootDirectory'
+    <dt>'\$RootDirectory'
       <dd>returns the system root directory.
     </dl>
 
@@ -96,12 +96,12 @@ def evaluate(self, evaluation):
 
 
 class TemporaryDirectory(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/$TemporaryDirectory.html</url>
 
     <dl>
-    <dt>'$TemporaryDirectory'
+    <dt>'\$TemporaryDirectory'
       <dd>returns the directory used for temporary files.
     </dl>
 

diff --git a/mathics/builtin/files_io/filesystem.py b/mathics/builtin/files_io/filesystem.py
@@ -581,12 +581,12 @@ class FileInformation(Builtin):
 
 
 class FindFile(Builtin):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/FileFind.html</url>
 
     <dl>
       <dt>'FindFile'[$name$]
-      <dd>searches '$Path' for the given filename.
+      <dd>searches '\$Path' for the given filename.
     </dl>
 
     >> FindFile["ExampleData/sunflowers.jpg"]
@@ -835,12 +835,12 @@ def eval_n(self, filename, n, evaluation: Evaluation, options: dict):
 
 
 class Needs(Builtin):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/Needs.html</url>
 
     <dl>
     <dt>'Needs["context`"]'
-        <dd>loads the specified context if not already in '$Packages'.
+        <dd>loads the specified context if not already in '\$Packages'.
     </dl>
 
     >> Needs["VectorAnalysis`"]
@@ -883,12 +883,12 @@ def eval(self, context, evaluation):
 
 
 class OperatingSystem(Predefined):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/OperatingSystem.html</url>
 
     <dl>
-      <dt>'$OperatingSystem'
+      <dt>'\$OperatingSystem'
       <dd>gives the type of operating system running Mathics.
     </dl>
 
@@ -912,13 +912,13 @@ def evaluate(self, evaluation):
 
 
 class PathnameSeparator(Predefined):
-    """
+    r"""
     <url>
     :WMA link:
     https://reference.wolfram.com/language/ref/$PathnameSeparator.html</url>
 
     <dl>
-      <dt>'$PathnameSeparator'
+      <dt>'\$PathnameSeparator'
       <dd>returns a string for the separator in paths.
     </dl>
 

diff --git a/mathics/builtin/files_io/importexport.py b/mathics/builtin/files_io/importexport.py
@@ -1,17 +1,17 @@
 # -*- coding: utf-8 -*-
 
-"""
+r"""
 Importing and Exporting
 
 Many kinds data formats can be read into \\Mathics. Variable <url>
-:$ExportFormats:
-/doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/$exportformats</url> \
+:\$ExportFormats:
+/doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/\$exportformats</url> \
 contains a list of file formats that are supported by <url>
 :Export:
 /doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/export</url>, \
 while <url>
-:$ImportFormats:
-/doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/$importformats</url> \
+:\$ImportFormats:
+/doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/\$importformats</url> \
 does the corresponding thing for <url>
 :Import:
 /doc/reference-of-built-in-symbols/inputoutput-files-and-filesystem/importing-and-exporting/import</url>.
@@ -942,11 +942,11 @@ def _importer_exporter_options(
 
 
 class ConverterDumpsExtensionMappings(Predefined):
-    """
+    r"""
     ## <url>:internal native symbol:</url>
 
     <dl>
-      <dt>'System`ConvertersDump`$ExtensionMappings'
+      <dt>'System`ConvertersDump`\$ExtensionMappings'
       <dd>Returns a list of associations between file extensions and file types.
     </dl>
 
@@ -966,11 +966,11 @@ def evaluate(self, evaluation: Evaluation):
 
 
 class ConverterDumpsFormatMappings(Predefined):
-    """
+    r"""
     ## <url>:internal native symbol:</url>
 
     <dl>
-      <dt>'System`ConverterDump$FormatMappings'
+      <dt>'System`ConverterDump\$FormatMappings'
       <dd>Returns a list of associations between file extensions and file types.
     </dl>
 
@@ -992,11 +992,11 @@ def evaluate(self, evaluation: Evaluation):
 
 
 class ExportFormats(Predefined):
-    """
-    <url>:WMA link:https://reference.wolfram.com/language/ref/$ExportFormats.html</url>
+    r"""
+    <url>:WMA link:https://reference.wolfram.com/language/ref/\$ExportFormats.html</url>
 
     <dl>
-      <dt>'$ExportFormats'
+      <dt>'\$ExportFormats'
       <dd>returns a list of file formats supported by Export.
     </dl>
 
@@ -1012,11 +1012,11 @@ def evaluate(self, evaluation: Evaluation):
 
 
 class ImportFormats(Predefined):
-    """
+    r"""
     <url>:WMA link:https://reference.wolfram.com/language/ref/$ImportFormats.html</url>
 
     <dl>
-      <dt>'$ImportFormats'
+      <dt>'\$ImportFormats'
       <dd>returns a list of file formats supported by Import.
     </dl>
 

diff --git a/mathics/builtin/numbers/randomnumbers.py b/mathics/builtin/numbers/randomnumbers.py
@@ -471,7 +471,7 @@ class RandomInteger(Builtin):
      .
      . ...   ...   ...
 
-    Calling 'RandomInteger' changes '$RandomState':
+    Calling 'RandomInteger' changes '\$RandomState':
     >> previousState = $RandomState;
     >> RandomInteger[]
      = ...
@@ -606,11 +606,11 @@ def eval_list(self, xmin, xmax, ns, evaluation):
 
 
 class RandomState(Builtin):
-    """
+    r"""
     <url>:WMA link:
     https://reference.wolfram.com/language/ref/RandomState.html</url>
     <dl>
-      <dt>'$RandomState'
+      <dt>'\$RandomState'
       <dd>is a long number representing the internal state of the \
           pseudo-random number generator.
     </dl>