sagemathgh-38145: docstrings: INPUT formatting

Separate ` ``x, y`` ` to ` ``x``, ``y`` ` and remove excessive newlines. URL: sagemath#38145 Reported by: gmou3 Reviewer(s): gmou3, Kwankyu Lee
kryzar · Jun 7, 2024 · dcc802b · dcc802b
2 parents cfb5065 + 3249f5b
commit dcc802b
Show file tree

Hide file tree

Showing 743 changed files with 650 additions and 1,386 deletions.
diff --git a/build/pkgs/configure/checksums.ini b/build/pkgs/configure/checksums.ini
@@ -1,3 +1,3 @@
 tarball=configure-VERSION.tar.gz
-sha1=022699b7eb21eccbc8f9d15fe354069f2cf125fc
-sha256=1dc7bc34f697b658b026772bb2d3c10875c5fa3be96d2d58a4e1b794f4b6ac3d
+sha1=14af118d49c9381989e4ea2409817248d34ebf19
+sha256=860c9d730e6bd766be52c304e3fc5bef30e022ba35c0a3eb227c0930255426b0
diff --git a/build/pkgs/configure/package-version.txt b/build/pkgs/configure/package-version.txt
@@ -1 +1 @@
-973a7e3600d01aede4d21d94d1ff58e7d1631af1
+be566915755fbfad85571c4a82e25404b43d10cb
diff --git a/build/pkgs/database_symbolic_data/spkg-install.in b/build/pkgs/database_symbolic_data/spkg-install.in
@@ -15,6 +15,3 @@ if [ $? -ne 0 ]; then
     echo >&2 "Error installing symbolic data."
     exit 1
 fi
-
-
-
diff --git a/build/pkgs/jmol/appletweb/JmolHelp.html b/build/pkgs/jmol/appletweb/JmolHelp.html
@@ -2,8 +2,6 @@
 <html><head>
 
 
-
-
   <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>JmolHelp</title>
 
   <meta content="J. Gutow" name="author">

diff --git a/build/pkgs/sympow/email-exchange.txt b/build/pkgs/sympow/email-exchange.txt
@@ -17,10 +17,6 @@ work fine on any system that uses 53-bit doubles. On other systems,
 it will still work for computations less than 16 or so digits (though
 the current version might die on start-up).
 
-
-
-
-
 NOTES:
 
 1. getline conflicts with a system-wide function name on

diff --git a/build/sage_bootstrap/cmdline.py b/build/sage_bootstrap/cmdline.py
@@ -40,7 +40,6 @@
 Provides scripts to manage the packages of Sage-the-distribution,
 including SageMath's database of equivalent system packages,
 and to download and upload tarballs from/to SageMath servers.
-
 """
 
 

diff --git a/build/sage_bootstrap/download/cmdline.py b/build/sage_bootstrap/download/cmdline.py
@@ -34,7 +34,6 @@
 """
 
 
-
 def make_parser():
     """
     The commandline argument parser for sage-download-file
@@ -46,7 +45,7 @@ def make_parser():
                         help='one of [DEBUG, INFO, ERROR, WARNING, CRITICAL]')
 
     parser.add_argument(
-        '--print-fastest-mirror', action='store_true', 
+        '--print-fastest-mirror', action='store_true',
         help='Print out the fastest mirror. All other arguments are ignored in that case.')
 
     parser.add_argument(
@@ -72,7 +71,7 @@ def make_parser():
         help="""Where to write the file. If the destination is not specified, a url
         will be downloaded and the content written to stdout and a
         tarball will be saved under {SAGE_DISTFILES}""".format(SAGE_DISTFILES=SAGE_DISTFILES))
-    
+
     parser.add_argument(
         '--no-check-certificate', action='store_true',
         help='Do not check SSL certificates for https connections')
@@ -122,7 +121,7 @@ def format_error(message):
     sys.stderr.write(message)
     sys.stderr.write(stars)
 
-                
+
 def run_safe():
     try:
         run()
@@ -132,6 +131,6 @@ def run_safe():
         finally:
             sys.exit(1)
 
-        
+
 if __name__ == '__main__':
     run_safe()
diff --git a/build/sage_bootstrap/uncompress/action.py b/build/sage_bootstrap/uncompress/action.py
@@ -22,7 +22,6 @@
 ARCHIVE_TYPES = [SageTarFile, SageZipFile, SageTarXZFile]
 
 
-
 def open_archive(filename):
     """
     Automatically detect archive type

diff --git a/m4/ax_boost_base.m4 b/m4/ax_boost_base.m4
@@ -187,7 +187,6 @@ AC_DEFUN([_AX_BOOST_BASE_RUNDETECT],[
     AC_LANG_POP([C++])
 
 
-
     dnl if we found no boost with system layout we search for boost libraries
     dnl built and installed without the --layout=system option or for a staged(not installed) version
     if test "x$succeeded" != "xyes" ; then

diff --git a/pkgs/sage-sws2rst/sage_sws2rst/worksheet2rst.py b/pkgs/sage-sws2rst/sage_sws2rst/worksheet2rst.py
@@ -3,7 +3,7 @@
 r"""
 Convert worksheet.html files into ReStructuredText documents
 
-This is called by 'sage -sws2rst'. Can also be used as a commandline script 
+This is called by 'sage -sws2rst'. Can also be used as a commandline script
 (if BeautifulSoup is installed):
 
 ``python worksheet2rst.py worksheet.html``
@@ -17,7 +17,7 @@
 - Pablo Angulo Ardoy (2011-02-25): initial version
 
 
-The content of worksheet.html is split into comments, code, and output 
+The content of worksheet.html is split into comments, code, and output
 (the result of evaluating the code), as follows:
 
 comments
@@ -28,7 +28,6 @@
 }}}
 
 Each kind of text is dealt with separately.
-
 """
 
 #**************************************************
@@ -84,7 +83,7 @@ class States(object):
 
 def code_parser(text):
     """
-    
+
     Arguments:
 
     INPUT:
@@ -95,7 +94,7 @@ def code_parser(text):
 
     - string -- rst text
 
-    EXAMPLES (not used for unit test, see 
+    EXAMPLES (not used for unit test, see
     http://groups.google.com/group/sage-devel/browse_thread/thread/d82cb049ac102f3a)
 
     : from sage_sws2rst.worksheet2rst import code_parser
@@ -140,7 +139,7 @@ def worksheet2rst(s, images_dir=''):
 
     - string -- rst text
 
-    EXAMPLES (not used for unit test, see 
+    EXAMPLES (not used for unit test, see
     http://groups.google.com/group/sage-devel/browse_thread/thread/d82cb049ac102f3a)
 
     : from sage_sws2rst.worksheet2rst import worksheet2rst
@@ -156,7 +155,7 @@ def worksheet2rst(s, images_dir=''):
     ls = []
     for line in s.splitlines():
         regex, next_state= transitions[state]
-        m = regex.match(line) 
+        m = regex.match(line)
         if m:
             if state == States.COMMENT:
                 last_cell_id = m.group(1)
@@ -192,7 +191,7 @@ def worksheet2rst(s, images_dir=''):
     return '\n'.join(result)
 
 if __name__=='__main__':
-    if len(sys.argv)>1:        
+    if len(sys.argv)>1:
         fichero = codecs.open(sys.argv[1], mode='r', encoding='utf-8')
         text = fichero.read()
         fichero.close()

diff --git a/pkgs/sagemath-objects/MANIFEST.in b/pkgs/sagemath-objects/MANIFEST.in
@@ -74,7 +74,6 @@ include sage/rings/integer_fake.*
 graft sage/libs/gmp
 
 
-
 ## What we do not want:
 # sage/misc/latex         -- this should really go to another package
 

diff --git a/src/bin/sage-fixdoctests b/src/bin/sage-fixdoctests
@@ -1,5 +1,4 @@
 #!/usr/bin/env sage-python
-
 """
 Given the output of doctest and a file, adjust the doctests so they won't fail.
 

diff --git a/src/bin/sage-notebook b/src/bin/sage-notebook
@@ -127,7 +127,6 @@ EXAMPLES:
 * Export a legacy Sage notebook as a Jupyter notebook:
 
       sage --notebook=export --ipynb=Output.ipynb admin:10
-
 """
 
 notebook_launcher = {

diff --git a/src/conftest.py b/src/conftest.py
@@ -1,5 +1,4 @@
 # pyright: strict
-
 """Configuration and fixtures for pytest.
 
 This file configures pytest and provides some global fixtures.

diff --git a/src/doc/common/static/custom-jupyter-sphinx.css b/src/doc/common/static/custom-jupyter-sphinx.css
@@ -134,7 +134,3 @@ body[data-theme="dark"] {
   }
  }
 }
-
-
-
-
diff --git a/src/doc/de/thematische_anleitungen/sage_gymnasium.rst b/src/doc/de/thematische_anleitungen/sage_gymnasium.rst
@@ -1223,7 +1223,6 @@ benutzen wir ``divisors()``::
     [1, 2, 3, 4, 6, 12, 13, 26, 39, 52, 78, 156]
 
 
-
 Weiterführende Links und Literatur
 ==================================
 

diff --git a/src/doc/de/tutorial/interactive_shell.rst b/src/doc/de/tutorial/interactive_shell.rst
@@ -505,7 +505,6 @@ Hilfe, und ``V.coordinates??`` um den Quelltext der Funktion zu
 sehen.
 
 
-
 Integriertes Hilfesystem
 ========================
 

diff --git a/src/doc/de/tutorial/introduction.rst b/src/doc/de/tutorial/introduction.rst
@@ -71,7 +71,6 @@ zur Installation von Sage auf Ihrem Computer zu erhalten.
 Hier geben wir nur ein paar Kommentare ab.
 
 
-
 #. Die herunterladbare Sage-Datei wurde nach der *batteries included*
    Philosophie zusammengestellt. In anderen Worten, obwohl Sage
    Python, IPython, PARI, GAP, Singular, Maxima, NTL, GMP und so

diff --git a/src/doc/de/tutorial/tour_algebra.rst b/src/doc/de/tutorial/tour_algebra.rst
@@ -193,7 +193,6 @@ modelliert,
     m_2 x_2''+ k_2 (x_2-x_1) = 0,
 
 
-
 wobei :math:`m_{i}` die Masse des Objekts *i*, :math:`x_{i}` die
 Verschiebung des Gleichgewichts der Masse *i* und :math:`k_{i}` die
 Federkonstante der Feder *i* ist.

diff --git a/src/doc/en/constructions/linear_codes.rst b/src/doc/en/constructions/linear_codes.rst
@@ -241,7 +241,6 @@ The LFSR sequence is then
    \end{array}
 
 
-
 The sequence of :math:`0,1`'s is periodic with period
 :math:`P=2^4-1=15` and satisfies Golomb's three randomness
 conditions. However, this sequence of period 15 can be "cracked"

diff --git a/src/doc/en/developer/coding_in_other.rst b/src/doc/en/developer/coding_in_other.rst
@@ -156,7 +156,6 @@ convert output from PARI to Sage objects:
             return F, B
 
 
-
 .. _section-gap:
 
 GAP

diff --git a/src/doc/en/developer/packaging.rst b/src/doc/en/developer/packaging.rst
@@ -568,7 +568,6 @@ pip for use in a separate process, like ``tox``, then this should be
 possible.
 
 
-
 .. _section-spkg-check:
 
 Self-tests
@@ -765,7 +764,6 @@ packages add dependencies that happen to be Sage packages, there is a
 separate source of instability.
 
 
-
 .. _section-spkg-SPKG-txt:
 
 The SPKG.rst file

diff --git a/src/doc/en/faq/faq-general.rst b/src/doc/en/faq/faq-general.rst
@@ -315,7 +315,6 @@ following commands:
     $ ./sage --advanced
 
 
-
 I want to cite Sage in a publication, how do I do it?
 """""""""""""""""""""""""""""""""""""""""""""""""""""
 

diff --git a/src/doc/en/reference/plot3d/threejs.rst b/src/doc/en/reference/plot3d/threejs.rst
@@ -144,7 +144,6 @@ An :meth:`~sage.plot.animate.Animation.interactive` animation::
     :file: threejs_examples/animation.html
 
 
-
 .. RAW:: html
 
     <script>

diff --git a/src/doc/en/thematic_tutorials/coercion_and_categories.rst b/src/doc/en/thematic_tutorials/coercion_and_categories.rst
@@ -91,7 +91,6 @@ elements. But some old stuff in Sage doesn't use it.  **Volunteers for
 refactoring are welcome!**
 
 
-
 The parent
 ----------
 

diff --git a/...doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_introduction.rst b/...doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_introduction.rst
@@ -254,7 +254,6 @@ consider the cubic equation
   x^3 + \sqrt{2} x + 5 = 0.
 
 
-
 In Sage, we can create this equation, and find an exact symbolic
 solution.
 

diff --git a/src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_orders.rst b/src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_orders.rst
@@ -74,7 +74,6 @@ has maximal order with :math:`\ZZ`-basis
     1, \frac{1}{2} a^{2} + \frac{1}{2} a,  a^{2}.
 
 
-
 ::
 
     sage: K.<a> = NumberField(x^4 + 2)

diff --git a/src/doc/en/thematic_tutorials/geometry/polyhedra_quicktutorial.rst b/src/doc/en/thematic_tutorials/geometry/polyhedra_quicktutorial.rst
@@ -115,8 +115,6 @@ Check it out\-\-\-we started with an integer\-lattice polytope and dualized
 to a rational\-lattice polytope.  Let's look at that.
 
 
-
-
 ::
 
     sage: P1dual.plot()
@@ -191,7 +189,6 @@ However, if a polytope is  *not*  in `\ZZ`, for example if it's in `\QQ` or
 Keep all of this in mind as you take polar duals.
 
 
-
 Polytope Constructions
 """"""""""""""""""""""
 

diff --git a/src/doc/en/thematic_tutorials/numerical_sage/ctypes_examples.rst b/src/doc/en/thematic_tutorials/numerical_sage/ctypes_examples.rst
@@ -25,8 +25,6 @@ following C code.
     } double_sparse_matrix;
 
 
-
-
     double_sparse_matrix * initialize_matrix(int nrows, int ncols)
     {
       int i;

diff --git a/src/doc/en/thematic_tutorials/numerical_sage/parallel_laplace_solver.rst b/src/doc/en/thematic_tutorials/numerical_sage/parallel_laplace_solver.rst
@@ -78,7 +78,6 @@ this with the solver we wrote in the section on f2py.
             row_below=MPI.COMM_WORLD.Recv(1)
 
 
-
         if rank >0 and rank < size-1:
             row_below.shape=(1,num_points)
             row_above.shape=(1,num_points)
@@ -109,7 +108,6 @@ this with the solver we wrote in the section on f2py.
         num_iter=num_iter+1
 
 
-
     recvbuf=MPI.COMM_WORLD.Gather(my_grid,root)
     if rank==0:
         sol=numpy.array(recvbuf)
@@ -126,5 +124,5 @@ takes more time than just doing the iteration. However, on a
 takes only 6 seconds while the serial version we wrote earlier
 takes 20 seconds.
 
-Exercise: Rewrite the above using f2py, so that each process 
+Exercise: Rewrite the above using f2py, so that each process
 compiles a fortran function and uses that, how fast can you get this?
diff --git a/src/doc/en/thematic_tutorials/sandpile.rst b/src/doc/en/thematic_tutorials/sandpile.rst
@@ -122,7 +122,6 @@ Alternatives::
     [{1: 2, 2: 1, 3: 1}, {1: 2, 2: 2, 3: 3}]
 
 
-
 Since vertex 3 has become unstable after firing vertex 1, it can be fired,
 which causes vertex 2 to become unstable, etc.  Repeated firings eventually
 lead to a stable configuration.  The last line of the Sage code, above, is a
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		973a7e3600d01aede4d21d94d1ff58e7d1631af1
		be566915755fbfad85571c4a82e25404b43d10cb
Original file line number	Diff line number	Diff line change
Expand Up		@@ -15,6 +15,3 @@ if [ $? -ne 0 ]; then
		echo >&2 "Error installing symbolic data."
		exit 1
		fi
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,8 +2,6 @@
		<html><head>




		<meta content="text/html; charset=ISO-8859-1" http-equiv="content-type"><title>JmolHelp</title>

		<meta content="J. Gutow" name="author">
Expand Down
-Original file line number
+Diff line change
@@ Expand Up @@
     it will still work for computations less than 16 or so digits (though
     the current version might die on start-up).
     NOTES:
 . getline conflicts with a system-wide function name on
@@ Expand Down @@
Original file line number	Diff line number	Diff line change
Expand Up		@@ -74,7 +74,6 @@ include sage/rings/integer_fake.*
		graft sage/libs/gmp



		## What we do not want:
		# sage/misc/latex -- this should really go to another package

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -1223,7 +1223,6 @@ benutzen wir ``divisors()``::
		[1, 2, 3, 4, 6, 12, 13, 26, 39, 52, 78, 156]



		Weiterführende Links und Literatur
		==================================

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -505,7 +505,6 @@ Hilfe, und ``V.coordinates??`` um den Quelltext der Funktion zu
		sehen.



		Integriertes Hilfesystem
		========================

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -156,7 +156,6 @@ convert output from PARI to Sage objects:
		return F, B



		.. _section-gap:

		GAP
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -315,7 +315,6 @@ following commands:
		$ ./sage --advanced



		I want to cite Sage in a publication, how do I do it?
		"""""""""""""""""""""""""""""""""""""""""""""""""""""

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -144,7 +144,6 @@ An :meth:`~sage.plot.animate.Animation.interactive` animation::
		:file: threejs_examples/animation.html



		.. RAW:: html

		<script>
Expand Down