Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation to LaurentSeries point to accessors #39366

Merged
merged 8 commits into from
Feb 21, 2025
19 changes: 10 additions & 9 deletions src/sage/rings/laurent_series_ring_element.pyx
Original file line number Diff line number Diff line change
@@ -1,6 +1,12 @@
"""
r"""
Laurent Series

Laurent series in Sage are represented internally as a power of the variable
times the power series part. If a Laurent series `f` is represented as
`f = t^n \cdot u` where `t` is the variable and `u` has nonzero constant term,
`u` can be accessed through :meth:`~LaurentSeries.valuation_zero_part` and `n`
can be accessed through :meth:`~LaurentSeries.valuation`.

EXAMPLES::

sage: R.<t> = LaurentSeriesRing(GF(7), 't'); R
Expand Down Expand Up @@ -35,11 +41,6 @@ Saving and loading.
sage: loads(K.dumps()) == K # needs sage.rings.real_mpfr
True

IMPLEMENTATION: Laurent series in Sage are represented internally
as a power of the variable times the unit part (which need not be a
unit - it's a polynomial with nonzero constant term). The zero
Laurent series has unit part 0.

AUTHORS:

- William Stein: original version
Expand Down Expand Up @@ -89,8 +90,8 @@ cdef class LaurentSeries(AlgebraElement):
r"""
A Laurent Series.

We consider a Laurent series of the form `t^n \cdot f` where `f` is a
power series.
We consider a Laurent series of the form `f = t^n \cdot u` where `u` is a
power series with nonzero constant term.

INPUT:

Expand Down Expand Up @@ -1301,7 +1302,7 @@ cdef class LaurentSeries(AlgebraElement):
sage: g.valuation()
0

Note that the valuation of an element undistinguishable from
Note that the valuation of an element indistinguishable from
zero is infinite::

sage: h = f - f; h
Expand Down
Loading