Skip to content
This repository was archived by the owner on Jan 30, 2023. It is now read-only.

Commit c6de1c9

Browse files
author
Release Manager
committed
Trac #34574: Uniformize headline: functions
URL: https://trac.sagemath.org/34574 Reported by: klee Ticket author(s): Kwankyu Lee Reviewer(s): Matthias Koeppe
2 parents a9e3acb + 8184039 commit c6de1c9

17 files changed

+41
-47
lines changed

src/sage/functions/airy.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Airy Functions
2+
Airy functions
33
44
This module implements Airy functions and their generalized derivatives. It
55
supports symbolic functionality through Maxima and numeric evaluation through

src/sage/functions/bessel.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Bessel Functions
2+
Bessel functions
33
44
This module provides symbolic Bessel and Hankel functions, and their
55
spherical versions. These functions use the `mpmath library`_ for numerical

src/sage/functions/error.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Error Functions
2+
Error functions
33
44
This module provides symbolic error functions. These functions use the
55
`mpmath library` for numerical evaluation and Maxima, Pynac for

src/sage/functions/exp_integral.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Exponential Integrals
2+
Exponential integrals
33
44
AUTHORS:
55

src/sage/functions/generalized.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Generalized Functions
2+
Generalized functions
33
44
Sage implements several generalized functions (also known as
55
distributions) such as Dirac delta, Heaviside step functions. These

src/sage/functions/hyperbolic.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Hyperbolic Functions
2+
Hyperbolic functions
33
44
The full set of hyperbolic and inverse hyperbolic functions is
55
available:

src/sage/functions/hypergeometric.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Hypergeometric Functions
2+
Hypergeometric functions
33
44
This module implements manipulation of infinite hypergeometric series
55
represented in standard parametric form (as `\,_pF_q` functions).

src/sage/functions/jacobi.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Jacobi Elliptic Functions
2+
Jacobi elliptic functions
33
44
This module implements the 12 Jacobi elliptic functions, along with their
55
inverses and the Jacobi amplitude function.

src/sage/functions/log.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Logarithmic Functions
2+
Logarithmic functions
33
44
AUTHORS:
55

src/sage/functions/min_max.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Symbolic Minimum and Maximum
2+
Symbolic minimum and maximum
33
44
Sage provides a symbolic maximum and minimum due to the fact that the Python
55
builtin max and min are not able to deal with variables as users might expect.

src/sage/functions/orthogonal_polys.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Orthogonal Polynomials
2+
Orthogonal polynomials
33
44
Chebyshev polynomials
55
---------------------

src/sage/functions/piecewise.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# -*- coding: utf-8 -*-
22
r"""
3-
Piecewise-defined Functions
3+
Piecewise functions
44
55
This module implement piecewise functions in a single variable. See
66
:mod:`sage.sets.real_set` for more information about how to construct

src/sage/functions/prime_pi.pyx

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,13 @@
11
r"""
2-
Counting Primes
2+
Counting primes
3+
4+
EXAMPLES::
5+
6+
sage: z = sage.functions.prime_pi.PrimePi()
7+
sage: loads(dumps(z))
8+
prime_pi
9+
sage: loads(dumps(z)) == z
10+
True
311
412
AUTHORS:
513
@@ -12,14 +20,6 @@ AUTHORS:
1220
- Dima Pasechnik (2021): removed buggy cython code, replaced it with
1321
calls to primecount/primecountpy spkg
1422
15-
16-
EXAMPLES::
17-
18-
sage: z = sage.functions.prime_pi.PrimePi()
19-
sage: loads(dumps(z))
20-
prime_pi
21-
sage: loads(dumps(z)) == z
22-
True
2323
"""
2424

2525
# ****************************************************************************

src/sage/functions/special.py

+17-23
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,5 @@
11
r"""
2-
Miscellaneous Special Functions
3-
4-
AUTHORS:
5-
6-
- David Joyner (2006-13-06): initial version
7-
8-
- David Joyner (2006-30-10): bug fixes to pari wrappers of Bessel
9-
functions, hypergeometric_U
10-
11-
- William Stein (2008-02): Impose some sanity checks.
12-
13-
- David Joyner (2008-04-23): addition of elliptic integrals
14-
15-
- Eviatar Bach (2013): making elliptic integrals symbolic
16-
17-
- Eric Gourgoulhon (2022): add Condon-Shortley phase to spherical harmonics
2+
Miscellaneous special functions
183
194
This module provides easy access to many of Maxima and PARI's
205
special functions.
@@ -104,6 +89,11 @@
10489
10590
and the complete ones are obtained by taking `\phi =\pi/2`.
10691
92+
.. WARNING::
93+
94+
SciPy's versions are poorly documented and seem less accurate than the
95+
Maxima and PARI versions. Typically they are limited by hardware floats
96+
precision.
10797
10898
REFERENCES:
10999
@@ -118,16 +108,20 @@
118108
119109
AUTHORS:
120110
121-
- David Joyner and William Stein
111+
- David Joyner (2006-13-06): initial version
122112
123-
Added 16-02-2008 (wdj): optional calls to scipy and replace all
124-
'#random' by '...' (both at the request of William Stein)
113+
- David Joyner (2006-30-10): bug fixes to pari wrappers of Bessel
114+
functions, hypergeometric_U
125115
126-
.. warning::
116+
- William Stein (2008-02): Impose some sanity checks.
127117
128-
SciPy's versions are poorly documented and seem less
129-
accurate than the Maxima and PARI versions; typically they are limited
130-
by hardware floats precision.
118+
- David Joyner (2008-02-16): optional calls to scipy and replace all ``#random`` by ``...``
119+
120+
- David Joyner (2008-04-23): addition of elliptic integrals
121+
122+
- Eviatar Bach (2013): making elliptic integrals symbolic
123+
124+
- Eric Gourgoulhon (2022): add Condon-Shortley phase to spherical harmonics
131125
"""
132126

133127
# ****************************************************************************

src/sage/functions/spike_function.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Spike Functions
2+
Spike functions
33
44
AUTHORS:
55

src/sage/functions/transcendental.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Number-Theoretic Functions
2+
Number-theoretic functions
33
"""
44
# ****************************************************************************
55
# Copyright (C) 2005 William Stein <[email protected]>

src/sage/functions/trig.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
r"""
2-
Trigonometric Functions
2+
Trigonometric functions
33
"""
44
from sage.symbolic.function import GinacFunction
55
import math

0 commit comments

Comments
 (0)