Skip to content

Commit e166abf

Browse files
gmou3gmou3
committed
Docstring formatting (outside of src/sage)
1 parent a80254e commit e166abf

File tree

67 files changed

+21
-150
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+21
-150
lines changed

‎build/pkgs/database_symbolic_data/spkg-install.in

-3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,3 @@ if [ $? -ne 0 ]; then
1515
echo >&2 "Error installing symbolic data."
1616
exit 1
1717
fi
18-
19-
20-

‎build/pkgs/jmol/appletweb/JmolHelp.html

-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
<html><head>
33

44

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

97
<meta content="J. Gutow" name="author">

‎build/pkgs/sympow/email-exchange.txt

-4
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,6 @@ work fine on any system that uses 53-bit doubles. On other systems,
1717
it will still work for computations less than 16 or so digits (though
1818
the current version might die on start-up).
1919

20-
21-
22-
23-
2420
NOTES:
2521

2622
1. getline conflicts with a system-wide function name on

‎build/sage_bootstrap/cmdline.py

-1
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@
4040
Provides scripts to manage the packages of Sage-the-distribution,
4141
including SageMath's database of equivalent system packages,
4242
and to download and upload tarballs from/to SageMath servers.
43-
4443
"""
4544

4645

‎build/sage_bootstrap/download/cmdline.py

+4-5
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,6 @@
3434
"""
3535

3636

37-
3837
def make_parser():
3938
"""
4039
The commandline argument parser for sage-download-file
@@ -46,7 +45,7 @@ def make_parser():
4645
help='one of [DEBUG, INFO, ERROR, WARNING, CRITICAL]')
4746

4847
parser.add_argument(
49-
'--print-fastest-mirror', action='store_true',
48+
'--print-fastest-mirror', action='store_true',
5049
help='Print out the fastest mirror. All other arguments are ignored in that case.')
5150

5251
parser.add_argument(
@@ -72,7 +71,7 @@ def make_parser():
7271
help="""Where to write the file. If the destination is not specified, a url
7372
will be downloaded and the content written to stdout and a
7473
tarball will be saved under {SAGE_DISTFILES}""".format(SAGE_DISTFILES=SAGE_DISTFILES))
75-
74+
7675
parser.add_argument(
7776
'--no-check-certificate', action='store_true',
7877
help='Do not check SSL certificates for https connections')
@@ -122,7 +121,7 @@ def format_error(message):
122121
sys.stderr.write(message)
123122
sys.stderr.write(stars)
124123

125-
124+
126125
def run_safe():
127126
try:
128127
run()
@@ -132,6 +131,6 @@ def run_safe():
132131
finally:
133132
sys.exit(1)
134133

135-
134+
136135
if __name__ == '__main__':
137136
run_safe()

‎build/sage_bootstrap/uncompress/action.py

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@
2222
ARCHIVE_TYPES = [SageTarFile, SageZipFile, SageTarXZFile]
2323

2424

25-
2625
def open_archive(filename):
2726
"""
2827
Automatically detect archive type

‎m4/ax_boost_base.m4

-1
Original file line numberDiff line numberDiff line change
@@ -187,7 +187,6 @@ AC_DEFUN([_AX_BOOST_BASE_RUNDETECT],[
187187
AC_LANG_POP([C++])
188188
189189
190-
191190
dnl if we found no boost with system layout we search for boost libraries
192191
dnl built and installed without the --layout=system option or for a staged(not installed) version
193192
if test "x$succeeded" != "xyes" ; then

‎pkgs/sage-sws2rst/sage_sws2rst/worksheet2rst.py

+7-8
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
r"""
44
Convert worksheet.html files into ReStructuredText documents
55
6-
This is called by 'sage -sws2rst'. Can also be used as a commandline script
6+
This is called by 'sage -sws2rst'. Can also be used as a commandline script
77
(if BeautifulSoup is installed):
88
99
``python worksheet2rst.py worksheet.html``
@@ -17,7 +17,7 @@
1717
- Pablo Angulo Ardoy (2011-02-25): initial version
1818
1919
20-
The content of worksheet.html is split into comments, code, and output
20+
The content of worksheet.html is split into comments, code, and output
2121
(the result of evaluating the code), as follows:
2222
2323
comments
@@ -28,7 +28,6 @@
2828
}}}
2929
3030
Each kind of text is dealt with separately.
31-
3231
"""
3332

3433
#**************************************************
@@ -84,7 +83,7 @@ class States(object):
8483

8584
def code_parser(text):
8685
"""
87-
86+
8887
Arguments:
8988
9089
INPUT:
@@ -95,7 +94,7 @@ def code_parser(text):
9594
9695
- string -- rst text
9796
98-
EXAMPLES (not used for unit test, see
97+
EXAMPLES (not used for unit test, see
9998
http://groups.google.com/group/sage-devel/browse_thread/thread/d82cb049ac102f3a)
10099
101100
: from sage_sws2rst.worksheet2rst import code_parser
@@ -140,7 +139,7 @@ def worksheet2rst(s, images_dir=''):
140139
141140
- string -- rst text
142141
143-
EXAMPLES (not used for unit test, see
142+
EXAMPLES (not used for unit test, see
144143
http://groups.google.com/group/sage-devel/browse_thread/thread/d82cb049ac102f3a)
145144
146145
: from sage_sws2rst.worksheet2rst import worksheet2rst
@@ -156,7 +155,7 @@ def worksheet2rst(s, images_dir=''):
156155
ls = []
157156
for line in s.splitlines():
158157
regex, next_state= transitions[state]
159-
m = regex.match(line)
158+
m = regex.match(line)
160159
if m:
161160
if state == States.COMMENT:
162161
last_cell_id = m.group(1)
@@ -192,7 +191,7 @@ def worksheet2rst(s, images_dir=''):
192191
return '\n'.join(result)
193192

194193
if __name__=='__main__':
195-
if len(sys.argv)>1:
194+
if len(sys.argv)>1:
196195
fichero = codecs.open(sys.argv[1], mode='r', encoding='utf-8')
197196
text = fichero.read()
198197
fichero.close()

‎pkgs/sagemath-objects/MANIFEST.in

-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ include sage/rings/integer_fake.*
7474
graft sage/libs/gmp
7575

7676

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

‎src/bin/sage-fixdoctests

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#!/usr/bin/env sage-python
2-
32
"""
43
Given the output of doctest and a file, adjust the doctests so they won't fail.
54

‎src/bin/sage-notebook

-1
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,6 @@ EXAMPLES:
127127
* Export a legacy Sage notebook as a Jupyter notebook:
128128
129129
sage --notebook=export --ipynb=Output.ipynb admin:10
130-
131130
"""
132131

133132
notebook_launcher = {

‎src/conftest.py

-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# pyright: strict
2-
32
"""Configuration and fixtures for pytest.
43
54
This file configures pytest and provides some global fixtures.

‎src/doc/common/static/custom-jupyter-sphinx.css

-4
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,3 @@ body[data-theme="dark"] {
134134
}
135135
}
136136
}
137-
138-
139-
140-

‎src/doc/de/thematische_anleitungen/sage_gymnasium.rst

-1
Original file line numberDiff line numberDiff line change
@@ -1223,7 +1223,6 @@ benutzen wir ``divisors()``::
12231223
[1, 2, 3, 4, 6, 12, 13, 26, 39, 52, 78, 156]
12241224

12251225

1226-
12271226
Weiterführende Links und Literatur
12281227
==================================
12291228

‎src/doc/de/tutorial/interactive_shell.rst

-1
Original file line numberDiff line numberDiff line change
@@ -505,7 +505,6 @@ Hilfe, und ``V.coordinates??`` um den Quelltext der Funktion zu
505505
sehen.
506506

507507

508-
509508
Integriertes Hilfesystem
510509
========================
511510

‎src/doc/de/tutorial/introduction.rst

-1
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,6 @@ zur Installation von Sage auf Ihrem Computer zu erhalten.
7171
Hier geben wir nur ein paar Kommentare ab.
7272

7373

74-
7574
#. Die herunterladbare Sage-Datei wurde nach der *batteries included*
7675
Philosophie zusammengestellt. In anderen Worten, obwohl Sage
7776
Python, IPython, PARI, GAP, Singular, Maxima, NTL, GMP und so

‎src/doc/de/tutorial/tour_algebra.rst

-1
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,6 @@ modelliert,
193193
m_2 x_2''+ k_2 (x_2-x_1) = 0,
194194
195195
196-
197196
wobei :math:`m_{i}` die Masse des Objekts *i*, :math:`x_{i}` die
198197
Verschiebung des Gleichgewichts der Masse *i* und :math:`k_{i}` die
199198
Federkonstante der Feder *i* ist.

‎src/doc/en/constructions/linear_codes.rst

-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,6 @@ The LFSR sequence is then
241241
\end{array}
242242
243243
244-
245244
The sequence of :math:`0,1`'s is periodic with period
246245
:math:`P=2^4-1=15` and satisfies Golomb's three randomness
247246
conditions. However, this sequence of period 15 can be "cracked"

‎src/doc/en/developer/coding_in_other.rst

-1
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,6 @@ convert output from PARI to Sage objects:
156156
return F, B
157157
158158
159-
160159
.. _section-gap:
161160

162161
GAP

‎src/doc/en/developer/packaging.rst

-2
Original file line numberDiff line numberDiff line change
@@ -568,7 +568,6 @@ pip for use in a separate process, like ``tox``, then this should be
568568
possible.
569569
570570
571-
572571
.. _section-spkg-check:
573572
574573
Self-tests
@@ -765,7 +764,6 @@ packages add dependencies that happen to be Sage packages, there is a
765764
separate source of instability.
766765
767766
768-
769767
.. _section-spkg-SPKG-txt:
770768
771769
The SPKG.rst file

‎src/doc/en/faq/faq-general.rst

-1
Original file line numberDiff line numberDiff line change
@@ -315,7 +315,6 @@ following commands:
315315
$ ./sage --advanced
316316
317317
318-
319318
I want to cite Sage in a publication, how do I do it?
320319
"""""""""""""""""""""""""""""""""""""""""""""""""""""
321320

‎src/doc/en/reference/plot3d/threejs.rst

-1
Original file line numberDiff line numberDiff line change
@@ -144,7 +144,6 @@ An :meth:`~sage.plot.animate.Animation.interactive` animation::
144144
:file: threejs_examples/animation.html
145145

146146

147-
148147
.. RAW:: html
149148

150149
<script>

‎src/doc/en/thematic_tutorials/coercion_and_categories.rst

-1
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,6 @@ elements. But some old stuff in Sage doesn't use it. **Volunteers for
9191
refactoring are welcome!**
9292

9393

94-
9594
The parent
9695
----------
9796

‎src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_introduction.rst

-1
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,6 @@ consider the cubic equation
254254
x^3 + \sqrt{2} x + 5 = 0.
255255
256256
257-
258257
In Sage, we can create this equation, and find an exact symbolic
259258
solution.
260259

‎src/doc/en/thematic_tutorials/explicit_methods_in_number_theory/nf_orders.rst

-1
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,6 @@ has maximal order with :math:`\ZZ`-basis
7474
1, \frac{1}{2} a^{2} + \frac{1}{2} a, a^{2}.
7575
7676
77-
7877
::
7978

8079
sage: K.<a> = NumberField(x^4 + 2)

‎src/doc/en/thematic_tutorials/geometry/polyhedra_quicktutorial.rst

-3
Original file line numberDiff line numberDiff line change
@@ -115,8 +115,6 @@ Check it out\-\-\-we started with an integer\-lattice polytope and dualized
115115
to a rational\-lattice polytope. Let's look at that.
116116

117117

118-
119-
120118
::
121119

122120
sage: P1dual.plot()
@@ -191,7 +189,6 @@ However, if a polytope is *not* in `\ZZ`, for example if it's in `\QQ` or
191189
Keep all of this in mind as you take polar duals.
192190

193191

194-
195192
Polytope Constructions
196193
""""""""""""""""""""""
197194

‎src/doc/en/thematic_tutorials/numerical_sage/ctypes_examples.rst

-2
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,6 @@ following C code.
2525
} double_sparse_matrix;
2626
2727
28-
29-
3028
double_sparse_matrix * initialize_matrix(int nrows, int ncols)
3129
{
3230
int i;

‎src/doc/en/thematic_tutorials/numerical_sage/parallel_laplace_solver.rst

+1-3
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,6 @@ this with the solver we wrote in the section on f2py.
7878
row_below=MPI.COMM_WORLD.Recv(1)
7979
8080
81-
8281
if rank >0 and rank < size-1:
8382
row_below.shape=(1,num_points)
8483
row_above.shape=(1,num_points)
@@ -109,7 +108,6 @@ this with the solver we wrote in the section on f2py.
109108
num_iter=num_iter+1
110109
111110
112-
113111
recvbuf=MPI.COMM_WORLD.Gather(my_grid,root)
114112
if rank==0:
115113
sol=numpy.array(recvbuf)
@@ -126,5 +124,5 @@ takes more time than just doing the iteration. However, on a
126124
takes only 6 seconds while the serial version we wrote earlier
127125
takes 20 seconds.
128126

129-
Exercise: Rewrite the above using f2py, so that each process
127+
Exercise: Rewrite the above using f2py, so that each process
130128
compiles a fortran function and uses that, how fast can you get this?

‎src/doc/en/thematic_tutorials/sandpile.rst

-1
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,6 @@ Alternatives::
122122
[{1: 2, 2: 1, 3: 1}, {1: 2, 2: 2, 3: 3}]
123123

124124

125-
126125
Since vertex 3 has become unstable after firing vertex 1, it can be fired,
127126
which causes vertex 2 to become unstable, etc. Repeated firings eventually
128127
lead to a stable configuration. The last line of the Sage code, above, is a

‎src/doc/en/thematic_tutorials/structures_in_coding_theory.rst

-4
Original file line numberDiff line numberDiff line change
@@ -650,7 +650,6 @@ derive from the one that follows.
650650
and self.dimension() == other.dimension())
651651
652652
653-
654653
class BinaryRepetitionCodeGeneratorMatrixEncoder(Encoder):
655654
656655
def __init__(self, code):
@@ -671,7 +670,6 @@ derive from the one that follows.
671670
return Matrix(GF(2), 1, n, [GF(2).one()] * n)
672671
673672
674-
675673
class BinaryRepetitionCodeStraightforwardEncoder(Encoder):
676674
677675
def __init__(self, code):
@@ -697,7 +695,6 @@ derive from the one that follows.
697695
return GF(2)
698696
699697
700-
701698
class BinaryRepetitionCodeMajorityVoteDecoder(Decoder):
702699
703700
def __init__(self, code):
@@ -732,7 +729,6 @@ derive from the one that follows.
732729
return (self.code().length()-1) // 2
733730
734731
735-
736732
BinaryRepetitionCode._registered_encoders["RepetitionGeneratorMatrixEncoder"] = BinaryRepetitionCodeGeneratorMatrixEncoder
737733
BinaryRepetitionCode._registered_encoders["RepetitionStraightforwardEncoder"] = BinaryRepetitionCodeStraightforwardEncoder
738734
BinaryRepetitionCode._registered_decoders["MajorityVoteDecoder"] = BinaryRepetitionCodeMajorityVoteDecoder

0 commit comments

Comments
 (0)