Skip to content

Commit d9fb7be

Browse files
author
Matthias Koeppe
committed
sage.rings: Docstring/doctest cosmetics
1 parent bf431b4 commit d9fb7be

19 files changed

+666
-692
lines changed

src/sage/rings/bernmm.pyx

+11-11
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Cython wrapper for bernmm library
1313
1414
AUTHOR:
1515
16-
- David Harvey (2008-06): initial version
16+
- David Harvey (2008-06): initial version
1717
"""
1818

1919
#*****************************************************************************
@@ -42,18 +42,18 @@ from sage.rings.rational cimport Rational
4242

4343
def bernmm_bern_rat(long k, int num_threads = 1):
4444
r"""
45-
Computes k-th Bernoulli number using a multimodular algorithm.
45+
Compute `k`-th Bernoulli number using a multimodular algorithm.
4646
(Wrapper for bernmm library.)
4747
4848
INPUT:
4949
50-
- k -- non-negative integer
51-
- num_threads -- integer >= 1, number of threads to use
50+
- ``k`` -- non-negative integer
51+
- ``num_threads`` -- integer `\geq 1`, number of threads to use
5252
5353
COMPLEXITY:
5454
55-
Pretty much quadratic in `k`. See the paper "A multimodular algorithm
56-
for computing Bernoulli numbers", David Harvey, 2008, for more details.
55+
Pretty much quadratic in `k`. See the paper "A multimodular algorithm
56+
for computing Bernoulli numbers", David Harvey, 2008, for more details.
5757
5858
EXAMPLES::
5959
@@ -98,18 +98,18 @@ def bernmm_bern_rat(long k, int num_threads = 1):
9898

9999
def bernmm_bern_modp(long p, long k):
100100
r"""
101-
Computes `B_k \mod p`, where `B_k` is the k-th Bernoulli number.
101+
Compute `B_k \mod p`, where `B_k` is the `k`-th Bernoulli number.
102102
103-
If `B_k` is not `p`-integral, returns -1.
103+
If `B_k` is not `p`-integral, return `-1`.
104104
105105
INPUT:
106106
107-
p -- a prime
108-
k -- non-negative integer
107+
- ``p`` -- a prime
108+
- ``k`` -- non-negative integer
109109
110110
COMPLEXITY:
111111
112-
Pretty much linear in `p`.
112+
Pretty much linear in `p`.
113113
114114
EXAMPLES::
115115

src/sage/rings/bernoulli_mod_p.pyx

+10-12
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,9 @@ def verify_bernoulli_mod_p(data):
5353
5454
INPUT:
5555
56-
data -- list, same format as output of bernoulli_mod_p function
56+
- ``data`` -- list, same format as output of :func:`bernoulli_mod_p` function
5757
58-
OUTPUT:
59-
60-
bool -- True if checksum passed
58+
OUTPUT: bool -- True if checksum passed
6159
6260
EXAMPLES::
6361
@@ -102,7 +100,7 @@ def bernoulli_mod_p(int p):
102100
103101
INPUT:
104102
105-
p -- integer, a prime
103+
- ``p`` -- integer, a prime
106104
107105
OUTPUT:
108106
@@ -134,7 +132,7 @@ def bernoulli_mod_p(int p):
134132
135133
AUTHOR:
136134
137-
-- David Harvey (2006-08-06)
135+
- David Harvey (2006-08-06)
138136
139137
"""
140138

@@ -233,12 +231,12 @@ def bernoulli_mod_p_single(long p, long k):
233231
r"""
234232
Return the Bernoulli number `B_k` mod `p`.
235233
236-
If `B_k` is not `p`-integral, an ArithmeticError is raised.
234+
If `B_k` is not `p`-integral, an :class:`ArithmeticError` is raised.
237235
238236
INPUT:
239237
240-
- p -- integer, a prime
241-
- k -- non-negative integer
238+
- ``p`` -- integer, a prime
239+
- ``k`` -- non-negative integer
242240
243241
OUTPUT:
244242
@@ -274,7 +272,7 @@ def bernoulli_mod_p_single(long p, long k):
274272
...
275273
ValueError: k must be non-negative
276274
277-
Check results against bernoulli_mod_p::
275+
Check results against :class:`bernoulli_mod_p`::
278276
279277
sage: bernoulli_mod_p(37)
280278
[1, 31, 16, 15, 16, 4, 17, 32, 22, 31, 15, 15, 17, 12, 29, 2, 0, 2]
@@ -303,8 +301,8 @@ def bernoulli_mod_p_single(long p, long k):
303301
304302
AUTHOR:
305303
306-
-- David Harvey (2007-08-31)
307-
-- David Harvey (2008-06): rewrote to use bernmm library
304+
- David Harvey (2007-08-31)
305+
- David Harvey (2008-06): rewrote to use bernmm library
308306
309307
"""
310308
if p <= 2:

0 commit comments

Comments
 (0)