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

Doctests and documentation patch #571

Merged
merged 9 commits into from
Jun 7, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix latex syntax in docstrings
  • Loading branch information
abhro committed May 18, 2024
commit 1aaf15622113ed2d6395bda7133edad6cc6cc06b
2 changes: 0 additions & 2 deletions docs/src/polynomials/polynomial.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,3 @@ FactoredPolynomial
RationalFunction
lowest_terms
```


6 changes: 3 additions & 3 deletions src/common.jl
Original file line number Diff line number Diff line change
Expand Up @@ -755,14 +755,14 @@ minimumexponent(::Type{<:AbstractPolynomial}) = 0
"""
firstindex(p::AbstractPolynomial)

The index of the smallest basis element, ``\beta_i``, represented by the coefficients. This is ``0`` for
The index of the smallest basis element, ``\\beta_i``, represented by the coefficients. This is ``0`` for
a zero polynomial.
"""
Base.firstindex(p::AbstractPolynomial) = 0 # XXX() is a better default
"""
lastindex(p::AbstractPolynomial)

The index of the largest basis element, ``\beta_i``, represented by the coefficients.
The index of the largest basis element, ``\\beta_i``, represented by the coefficients.
May be ``-1`` or ``0`` for the zero polynomial, depending on the storage type.
"""
Base.lastindex(p::AbstractPolynomial) = length(p) - 1 + firstindex(p) # not degree, which accounts for any trailing zeros
Expand Down Expand Up @@ -943,7 +943,7 @@ Base.oneunit(p::P, args...) where {P <: AbstractPolynomial} = one(p, args...)
variable(::Type{<:AbstractPolynomial}, var=:x)
variable(p::AbstractPolynomial, var=indeterminate(p))

Return the monomial `x` in the indicated polynomial basis. If no type is give, will default to [`Polynomial`](@ref). Equivalent to `P(var)`.
Return the monomial `x` in the indicated polynomial basis. If no type is give, will default to [`Polynomial`](@ref). Equivalent to `P(var)`.

# Examples
```jldoctest common
Expand Down