Docstring formatting within src/sage 2/3

saraedum · Jun 4, 2024 · eb0ba76 · eb0ba76
1 parent 356b238
commit eb0ba76
Show file tree

Hide file tree

Showing 297 changed files with 6 additions and 394 deletions.
diff --git a/src/sage/interfaces/expect.py b/src/sage/interfaces/expect.py
@@ -407,7 +407,6 @@ def _install_hints_ssh(self):
 
 In many cases, the server that can actually run "slave" is not accessible from the internet directly, but you have to hop through an intermediate trusted server, say "gate".
 If that is your case, get help with _install_hints_ssh_through_gate().
-
 """
 
     def _install_hints_ssh_through_gate(self):
@@ -450,7 +449,6 @@ def _install_hints_ssh_through_gate(self):
 
 If this all works, you can then make calls like:
          math = Mathematica(server="remote_for_sage")
-
 """
 
     def _do_cleaner(self):

diff --git a/src/sage/interfaces/fricas.py b/src/sage/interfaces/fricas.py
@@ -183,7 +183,6 @@
 
     sage: x = var('x'); ex = x^2*exp(-x)*Ei(x) - x; fricas(ex).limit(x=oo)
     1
-
 """
 
 ###########################################################################

diff --git a/src/sage/interfaces/genus2reduction.py b/src/sage/interfaces/genus2reduction.py
@@ -311,8 +311,6 @@ class Genus2reduction(SageObject):
 
                    y^2 + (x^3-x^2-1)y = x^2 - x.
 
-
-
     We have::
 
         sage: genus2reduction(x^3-x^2-1, x^2 - x)

diff --git a/src/sage/interfaces/giac.py b/src/sage/interfaces/giac.py
@@ -448,7 +448,6 @@ def _install_hints(self):
     ``$PREFIX``/share/giac/doc/en/cascmd_en/index.html
 
 If you got giac from the spkg then ``$PREFIX`` is ``$SAGE_LOCAL``
-
 """
 
     def expect(self):

diff --git a/src/sage/interfaces/lie.py b/src/sage/interfaces/lie.py
@@ -189,7 +189,6 @@
     5765224
 
 
-
 LiE's help can be accessed through lie.help('functionname') where
 functionname is the function you want to receive help for. ::
 
@@ -204,7 +203,6 @@
 This can also be accessed with lie.functionname? .
 
 
-
 With the exception of groups, all LiE data types can be converted into
 native Sage data types by calling the .sage() method.
 
@@ -272,8 +270,6 @@
     sage: eval_pol(a, b2)
     18
 
-
-
 AUTHORS:
 
 - Mike Hansen 2007-08-27

diff --git a/src/sage/interfaces/mathematica.py b/src/sage/interfaces/mathematica.py
@@ -413,7 +413,6 @@
      log(sqrt(1/x^2 + 1) + 1/x),
      log(sqrt(1/x + 1)*sqrt(1/x - 1) + 1/x),
      1/2*log(1/x + 1) - 1/2*log(-1/x + 1)]
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/interfaces/mathics.py b/src/sage/interfaces/mathics.py
@@ -352,9 +352,6 @@
 
 Thanks to Rocky Bernstein and Juan Mauricio Matera for their support. For further acknowledgments see `this list <https://github.com/mathics/Mathics/blob/master/AUTHORS.txt>`__.
 
-
-
-
 TESTS:
 
 Check that numerical approximations via Mathics's `N[]` function work

diff --git a/src/sage/interfaces/maxima.py b/src/sage/interfaces/maxima.py
@@ -475,8 +475,6 @@
     a and (b or c)
     sage: bar == foo
     True
-
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/interfaces/maxima_lib.py b/src/sage/interfaces/maxima_lib.py
@@ -96,7 +96,6 @@
     ....:     os.wait()
     ....: '''])
     sage: tmpdir.cleanup()
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/interfaces/mupad.py b/src/sage/interfaces/mupad.py
@@ -81,7 +81,6 @@
                                  q - t + q t - 1
                           P[2] + --------------- P[1, 1]
                                      q t - 1
-
 """
 
 # **************************************************************************

diff --git a/src/sage/interfaces/phc.py b/src/sage/interfaces/phc.py
@@ -18,7 +18,6 @@
 - Marshall Hampton -- second version of interface to PHC
 
 - Marshall Hampton and Alex Jokela -- third version, path tracking
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/interfaces/singular.py b/src/sage/interfaces/singular.py
@@ -322,7 +322,6 @@
 - Simon King (2011-06-06): Make conversion from Singular to Sage more flexible.
 
 - Simon King (2015): Extend pickling capabilities.
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/knots/knotinfo.py b/src/sage/knots/knotinfo.py
@@ -212,7 +212,6 @@
 - `LinkInfo <https://linkinfo.sitehost.iu.edu/>`__
 
 
-
 AUTHORS:
 
 - Sebastian Oehms August 2020: initial version

diff --git a/src/sage/lfunctions/dokchitser.py b/src/sage/lfunctions/dokchitser.py
@@ -15,7 +15,6 @@
   documentation below is based on Dokchitser's docs).
 
 - William Stein (2006-03-08): Sage interface
-
 """
 
 # ****************************************************************************

diff --git a/src/sage/lfunctions/pari.py b/src/sage/lfunctions/pari.py
@@ -6,7 +6,6 @@
 AUTHORS:
 
 - Frédéric Chapoton (2018) interface
-
 """
 # ****************************************************************************
 #       Copyright (C) 2018 Frédéric Chapoton <[email protected]>

diff --git a/src/sage/lfunctions/zero_sums.pyx b/src/sage/lfunctions/zero_sums.pyx
@@ -6,7 +6,6 @@ All computations are done to double precision.
 AUTHORS:
 
 - Simon Spicer (2014-10): first version
-
 """
 # ****************************************************************************
 #       Copyright (C) 2014 Simon Spicer <[email protected]>

diff --git a/src/sage/libs/coxeter3/coxeter.pyx b/src/sage/libs/coxeter3/coxeter.pyx
@@ -2,7 +2,6 @@
 # distutils: libraries = coxeter3
 # sage_setup: distribution = sagemath-coxeter3
 # sage.doctest: optional - coxeter3
-
 """
 Low level part of the interface to Fokko Ducloux's Coxeter 3 library
 

diff --git a/src/sage/libs/coxeter3/coxeter_group.py b/src/sage/libs/coxeter3/coxeter_group.py
@@ -1,6 +1,5 @@
 # sage_setup: distribution = sagemath-coxeter3
 # sage.doctest: optional - coxeter3
-
 """
 Coxeter Groups implemented with Coxeter3
 """

diff --git a/src/sage/libs/flint/flint_sage.pyx b/src/sage/libs/flint/flint_sage.pyx
@@ -3,7 +3,6 @@
 # WARNING: src/sage/libs/flint/flint_sage.pyx is generated from
 # src/sage_setup/autogen/flint/templates/flint_sage.pyx.template;
 # please make sure that you are modifying the correct file!
-
 """
 Flint imports
 

diff --git a/src/sage/libs/flint/types.pxd b/src/sage/libs/flint/types.pxd
@@ -3,7 +3,6 @@
 # WARNING: src/sage/libs/flint/types.pxd is generated from
 # src/sage_setup/autogen/flint/templates/types.pxd.template
 # please make sure that you are modifying the correct file!
-
 """
 Declarations for FLINT types
 """

diff --git a/src/sage/libs/giac/misc.h b/src/sage/libs/giac/misc.h
@@ -38,7 +38,7 @@ int  giacgenrichcmp(gen & a, gen & b, int op, const context * context_ptr){
     case 1 : //<=
        if (is_greater(b,a,context_ptr)) {rep = 1;}
        break;
-    case 2 ://== 
+    case 2 ://==
        if (operator_equal(b,a,context_ptr)) {rep = 1;}
        break;
     case 3 ://!=
@@ -66,9 +66,9 @@ gen  giacdiv(gen & a, gen & b, const context * context_ptr){
 
 gen  giacmod(gen & a, gen & b, const context * context_ptr){
   if(b != 0)
-     return eval(a * makemod(1,b),context_ptr); 
+     return eval(a * makemod(1,b),context_ptr);
   else
-    return eval(makemod(a,b),context_ptr); 
+    return eval(makemod(a,b),context_ptr);
 }
 
 int htmlbrowserhelp(char * s){
@@ -78,9 +78,6 @@ int htmlbrowserhelp(char * s){
     {return 1;}
 }
 
-
-
-
 string browser_help(const giac::gen & g, int language){
     giac::gen f(g);
     string s;
@@ -100,20 +97,18 @@ string browser_help(const giac::gen & g, int language){
 }
 
 
-
-
 void archivegen( const string filename, const gen & g, const context * context_ptr){
   ofstream of(filename.c_str());
   giac::archive(of,g,context_ptr);
   of.close();
-} 
+}
 
 gen unarchivegen( const string filename, const context * context_ptr){
   ifstream f(filename.c_str());
   gen g=giac::unarchive(f,context_ptr);
   f.close();
   return g;
-} 
+}
 
 
 #endif

diff --git a/src/sage/libs/gsl/chebyshev.pxd b/src/sage/libs/gsl/chebyshev.pxd
@@ -30,7 +30,6 @@ cdef extern from "gsl/gsl_chebyshev.h":
   int gsl_cheb_eval_mode_e( gsl_cheb_series * cs,  double x, gsl_mode_t mode, double * result, double * abserr)
 
 
-
   int gsl_cheb_calc_deriv(gsl_cheb_series * deriv,  gsl_cheb_series * cs)
 
   int gsl_cheb_calc_integ(gsl_cheb_series * integ,  gsl_cheb_series * cs)

diff --git a/src/sage/libs/gsl/complex.pxd b/src/sage/libs/gsl/complex.pxd
@@ -148,6 +148,3 @@ cdef extern from "gsl/gsl_complex_math.h":
   gsl_complex  gsl_complex_arccsch(gsl_complex z)
 
   gsl_complex  gsl_complex_arccoth(gsl_complex z)
-
-
-
diff --git a/src/sage/libs/gsl/fit.pxd b/src/sage/libs/gsl/fit.pxd
@@ -39,7 +39,6 @@ cdef extern from "gsl/gsl_fit.h":
                    double *y, double *y_err)
 
 
-
   int gsl_fit_poly ( double * x, double * w, double * y, size_t n,
                     double * c, size_t m, double * chisq)
 

diff --git a/src/sage/libs/gsl/histogram.pxd b/src/sage/libs/gsl/histogram.pxd
@@ -30,7 +30,6 @@ cdef extern from "gsl/gsl_histogram.h":
   int gsl_histogram_set_ranges_uniform (gsl_histogram * h, double xmin, double xmax)
 
 
-
   int gsl_histogram_memcpy(gsl_histogram * dest,  gsl_histogram * source)
 
   gsl_histogram * gsl_histogram_clone( gsl_histogram * source)

diff --git a/src/sage/libs/gsl/interp.pxd b/src/sage/libs/gsl/interp.pxd
@@ -74,7 +74,6 @@ cdef extern from "gsl/gsl_interp.h":
                             size_t index_lo, size_t index_hi)
 
 
-
 cdef extern from "gsl/gsl_spline.h":
   ctypedef struct gsl_spline
 

diff --git a/src/sage/libs/gsl/linalg.pxd b/src/sage/libs/gsl/linalg.pxd
@@ -81,7 +81,6 @@ cdef extern from "gsl/gsl_linalg.h":
   gsl_complex  gsl_linalg_complex_LU_sgndet(gsl_matrix_complex * LU, int signum)
 
 
-
   # QR decomposition
 
   int  gsl_linalg_QR_decomp(gsl_matrix * A, gsl_vector * tau)

diff --git a/src/sage/libs/gsl/matrix_complex.pxd b/src/sage/libs/gsl/matrix_complex.pxd
@@ -85,7 +85,6 @@ cdef extern from "gsl/gsl_matrix_complex_double.h":
   int  gsl_matrix_complex_fprintf(FILE * stream, gsl_matrix_complex * m, char * format)
 
 
-
   # Copying or exchanging elements
   int  gsl_matrix_complex_memcpy(gsl_matrix_complex * dest, gsl_matrix_complex * src)
 

diff --git a/src/sage/libs/gsl/odeiv.pxd b/src/sage/libs/gsl/odeiv.pxd
@@ -14,8 +14,6 @@ cdef extern from "gsl/gsl_odeiv.h":
   #define GSL_ODEIV_JA_EVAL(S,t,y,dfdy,dfdt)  (*((S)->jacobian))(t,y,dfdy,dfdt,(S)->params)
 
 
-
-
   ctypedef struct gsl_odeiv_step_type
 
   ctypedef struct gsl_odeiv_step

diff --git a/src/sage/libs/gsl/permutation.pxd b/src/sage/libs/gsl/permutation.pxd
@@ -58,7 +58,6 @@ cdef extern from "gsl/gsl_permutation.h":
   size_t  gsl_permutation_canonical_cycles(gsl_permutation * q)
 
 
-
 # Applying Permutations
 cdef extern from "gsl/gsl_permute_double.h":
   int  gsl_permute(size_t * p, double * data, size_t stride, size_t n)

diff --git a/src/sage/libs/linkages/padics/Polynomial_ram.pxi b/src/sage/libs/linkages/padics/Polynomial_ram.pxi
@@ -15,7 +15,6 @@ is independent of ramification is in Polynomial_shared.pxi.
 AUTHORS:
 
 - David Roe, Julian Rüth (2017-06-11): initial version
-
 """
 # ****************************************************************************
 #       Copyright (C) 2017 David Roe <[email protected]>

diff --git a/src/sage/libs/linkages/padics/Polynomial_shared.pxi b/src/sage/libs/linkages/padics/Polynomial_shared.pxi
@@ -14,7 +14,6 @@ where functions that depend on the ramification of the defining polynomial are p
 AUTHORS:
 
 - David Roe, Julian Rüth (2017-06-11): initial version
-
 """
 #*****************************************************************************
 #       Copyright (C) 2017 David Roe <[email protected]>

diff --git a/src/sage/libs/linkages/padics/fmpz_poly_unram.pxi b/src/sage/libs/linkages/padics/fmpz_poly_unram.pxi
@@ -5,7 +5,6 @@ using FLINT's fmpz_poly_t.
 AUTHORS:
 
 - David Roe, Julian Rueth (2013-03-21) -- initial version
-
 """
 #*****************************************************************************
 #       Copyright (C) 2013 David Roe <[email protected]>

diff --git a/src/sage/libs/lrcalc/lrcalc.py b/src/sage/libs/lrcalc/lrcalc.py
@@ -176,7 +176,6 @@
 
 - Anne Schilling, Nicolas M. Thiéry, and Anders Buch (2011): fusion
   product, iterating through LR tableaux, finalization, documentation
-
 """
 # ****************************************************************************
 #  Copyright (C) 2010 Mike Hansen <[email protected]>

diff --git a/src/sage/libs/m4rie.pxd b/src/sage/libs/m4rie.pxd
@@ -8,7 +8,6 @@
 from sage.libs.m4ri cimport mzd_t, m4ri_word
 
 
-
 cdef extern from "m4rie/m4rie.h":
     ctypedef struct gf2e:
         int degree

diff --git a/src/sage/libs/ntl/conversion.pxd b/src/sage/libs/ntl/conversion.pxd
@@ -8,7 +8,6 @@ conventions for conversion functions
 - ``new_sage_XXX``   : create a new Sage object
 - ``set_ntl_XXX`` : set the entries of the ntl object
 - ``set_sage_XXX``   : set the entries of the Sage object
-
 """
 #*****************************************************************************
 #       Copyright (C) 2007 Martin Albrecht

diff --git a/src/sage/libs/ntl/convert.pyx b/src/sage/libs/ntl/convert.pyx
@@ -5,7 +5,6 @@
 # distutils: library_dirs = NTL_LIBDIR
 # distutils: extra_link_args = NTL_LIBEXTRA
 # distutils: language = c++
-
 """
 Conversion between NTL's ``ZZ`` and various other types
 """

diff --git a/src/sage/libs/ntl/error.pyx b/src/sage/libs/ntl/error.pyx
@@ -5,7 +5,6 @@
 # distutils: library_dirs = NTL_LIBDIR
 # distutils: extra_link_args = NTL_LIBEXTRA
 # distutils: language = c++
-
 """
 NTL error handler
 

diff --git a/src/sage/libs/ntl/ntl_lzz_p.pyx b/src/sage/libs/ntl/ntl_lzz_p.pyx
@@ -4,7 +4,6 @@
 # distutils: library_dirs = NTL_LIBDIR
 # distutils: extra_link_args = NTL_LIBEXTRA
 # distutils: language = c++
-
 """
 ntl_lzz_p.pyx
 

diff --git a/src/sage/libs/ntl/ntl_lzz_pX.pyx b/src/sage/libs/ntl/ntl_lzz_pX.pyx
@@ -4,7 +4,6 @@
 # distutils: library_dirs = NTL_LIBDIR
 # distutils: extra_link_args = NTL_LIBEXTRA
 # distutils: language = c++
-
 """
 ntl_lzz_pX.pyx