Skip to content

Commit

Permalink
docstrings: remove ">" character at the start of lines
Browse files Browse the repository at this point in the history
Perl command:
perl -i -p -e 's/^> (.+)/\1/g' $(find -name \*\.jl)
  • Loading branch information
rfourquet committed Oct 27, 2020
1 parent b90dad4 commit 0cba706
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions src/Rings/mpoly.jl
Original file line number Diff line number Diff line change
Expand Up @@ -547,7 +547,7 @@ end
@doc Markdown.doc"""
jacobi_matrix(f::MPolyElem)
> Given a polynomial $f$ this function returns the Jacobian matrix ``J_f=(\partial_{x_1}f,...,\partial_{x_n}f)^T`` of $f$.
Given a polynomial $f$ this function returns the Jacobian matrix ``J_f=(\partial_{x_1}f,...,\partial_{x_n}f)^T`` of $f$.
"""
function jacobi_matrix(f::MPolyElem)
R = parent(f)
Expand All @@ -558,7 +558,7 @@ end
@doc Markdown.doc"""
jacobi_ideal(f::MPolyElem)
> Given a polynomial $f$ this function returns the Jacobian ideal of $f$.
Given a polynomial $f$ this function returns the Jacobian ideal of $f$.
"""
function jacobi_ideal(f::MPolyElem)
R = parent(f)
Expand All @@ -569,8 +569,8 @@ end
@doc Markdown.doc"""
jacobi_matrix(g::Array{<:MPolyElem, 1})
> Given an array ``g=[f_1,...,f_m]`` of polynomials over the same base ring,
> this function returns the Jacobian matrix ``J=(\partial_{x_i}f_j)_{i,j}`` of ``g``.
Given an array ``g=[f_1,...,f_m]`` of polynomials over the same base ring,
this function returns the Jacobian matrix ``J=(\partial_{x_i}f_j)_{i,j}`` of ``g``.
"""
function jacobi_matrix(g::Array{<:MPolyElem, 1})
R = parent(g[1])
Expand Down Expand Up @@ -745,9 +745,9 @@ end
@doc Markdown.doc"""
eliminate(I::MPolyIdeal, polys::Array{MPolyElem, 1})
> Given a list of polynomials which are variables, construct the ideal
> corresponding geometrically to the projection of the variety given by the
> ideal $I$ where those variables have been eliminated.
Given a list of polynomials which are variables, construct the ideal
corresponding geometrically to the projection of the variety given by the
ideal $I$ where those variables have been eliminated.
"""
function eliminate(I::MPolyIdeal, l::Array{<:MPolyElem, 1})
singular_assure(I)
Expand All @@ -760,9 +760,9 @@ end
@doc Markdown.doc"""
eliminate(I::MPolyIdeal, polys::AbstractArray{Int, 1})
> Given a list of indices, construct the ideal
> corresponding geometrically to the projection of the variety given by the
> ideal $I$ where those variables in the list have been eliminated.
Given a list of indices, construct the ideal
corresponding geometrically to the projection of the variety given by the
ideal $I$ where those variables in the list have been eliminated.
"""
function eliminate(I::MPolyIdeal, l::AbstractArray{Int, 1})
R = base_ring(I)
Expand Down

0 comments on commit 0cba706

Please sign in to comment.