Fix indentation of doc strings (#3744)

(cherry picked from commit 5bad134)
oscar-system · May 23, 2024 · 83f0c18 · 83f0c18
1 parent 644dc96
commit 83f0c18
Show file tree

Hide file tree

Showing 21 changed files with 54 additions and 54 deletions.
diff --git a/experimental/LieAlgebras/src/LieSubalgebra.jl b/experimental/LieAlgebras/src/LieSubalgebra.jl
@@ -87,7 +87,7 @@ function basis(S::LieSubalgebra, i::Int)
 end
 
 @doc raw"""
-  dim(S::LieSubalgebra) -> Int
+    dim(S::LieSubalgebra) -> Int
 
 Return the dimension of the Lie subalgebra `S`.
 """

diff --git a/experimental/LieAlgebras/src/RootSystem.jl b/experimental/LieAlgebras/src/RootSystem.jl
@@ -720,7 +720,7 @@ function Base.deepcopy_internal(w::WeightLatticeElem, dict::IdDict)
 end
 
 @doc raw"""
-  getindex(w::WeightLatticeElem, i::Int) -> ZZRingElem
+    getindex(w::WeightLatticeElem, i::Int) -> ZZRingElem
 
 Returns the coefficient of the `i`-th fundamental weight in `w`.
 """

diff --git a/experimental/QuadFormAndIsom/src/lattices_with_isometry.jl b/experimental/QuadFormAndIsom/src/lattices_with_isometry.jl
@@ -75,7 +75,7 @@ QuadSpaceWithIsom
 ambient_space(Lf::ZZLatWithIsom) = Lf.Vf
 
 @doc raw"""
-   ambient_isometry(Lf::ZZLatWithIsom) -> QQMatrix
+    ambient_isometry(Lf::ZZLatWithIsom) -> QQMatrix
 
 Given a lattice with isometry $(L, f)$, return an isometry of the ambient
 space of $L$ inducing $f$ on $L$.

diff --git a/experimental/Schemes/Sheaves.jl b/experimental/Schemes/Sheaves.jl
@@ -121,10 +121,10 @@ function restriction_map(F::PreSheafOnScheme{<:Any, OpenType, OutputType, Restri
 end
 
 @doc raw"""
-  add_incoming_restriction!(F::AbsPreSheaf{<:Any, OpenType, <:Any, RestrictionType},
-    U::OpenType,
-    rho::RestrictionType
-  ) where {OpenType, RestrictionType}
+    add_incoming_restriction!(F::AbsPreSheaf{<:Any, OpenType, <:Any, RestrictionType},
+      U::OpenType,
+      rho::RestrictionType
+    ) where {OpenType, RestrictionType}
 
 **Note:** This is a method for internal use!
 

diff --git a/experimental/Schemes/SpaceGerms.jl b/experimental/Schemes/SpaceGerms.jl
@@ -1004,7 +1004,7 @@ end
 # We want the singular locus of an `AbsSpaceGerm` to be a `SpaceGerm` again and
 # not a plain `AffineScheme`.
 @doc raw"""
-   singular_locus(X::AbsSpaceGerm)  --> SpaceGerm, ClosedEmbedding
+    singular_locus(X::AbsSpaceGerm)  --> SpaceGerm, ClosedEmbedding
 
 Return the space germ (Y,p) for a given germ (X,p) and the closed embedding of (Y,p) into (X,p), where Y is the singular locus of X.
 

diff --git a/experimental/Schemes/elliptic_surface.jl b/experimental/Schemes/elliptic_surface.jl
@@ -1284,7 +1284,7 @@ function horizontal_decomposition(X::EllipticSurface, F::Vector{QQFieldElem})
 end
 
 @doc raw"""
-  elliptic_parameter(X::EllipticSurface, F::Vector{QQFieldElem}) -> LinearSystem
+    elliptic_parameter(X::EllipticSurface, F::Vector{QQFieldElem}) -> LinearSystem
 
 Return the elliptic parameter ``u`` of the divisor class `F`. 
 
@@ -1324,7 +1324,7 @@ end
 
 
 @doc raw"""
-  extended_ade(ADE::Symbol, n::Int)
+    extended_ade(ADE::Symbol, n::Int)
 
 Return the dual intersection matrix of an extended ade Dynkin diagram
 as well as the isotropic vector (with positive coefficients in the roots).

diff --git a/src/AlgebraicGeometry/Curves/ProjectivePlaneCurve.jl b/src/AlgebraicGeometry/Curves/ProjectivePlaneCurve.jl
@@ -122,7 +122,7 @@ end
 # multiplicity
 
 @doc raw"""
-     multiplicity(C::ProjectivePlaneCurve{S}, P::AbsProjectiveRationalPoint)
+    multiplicity(C::ProjectivePlaneCurve{S}, P::AbsProjectiveRationalPoint)
 
 Return the multiplicity of `C` at `P`.
 """
@@ -155,8 +155,8 @@ end
 ################################################################################
 # tangent lines
 
- @doc raw"""
-      tangent_lines(C::ProjectivePlaneCurve{S}, P::AbsProjectiveRationalPoint) where S <: FieldElem
+@doc raw"""
+    tangent_lines(C::ProjectivePlaneCurve{S}, P::AbsProjectiveRationalPoint) where S <: FieldElem
 
 Return the tangent lines at `P` to `C` with their multiplicity.
 """
@@ -177,7 +177,7 @@ function tangent_lines(C::ProjectivePlaneCurve, P::AbsProjectiveRationalPoint)
 end
 
 @doc raw"""
-     intersection_multiplicity(C::S, D::S, P::AbsProjectiveRationalPoint) where S <: ProjectivePlaneCurve
+    intersection_multiplicity(C::S, D::S, P::AbsProjectiveRationalPoint) where S <: ProjectivePlaneCurve
 
 Return the intersection multiplicity of `C` and `D` at `P`.
 """
@@ -193,7 +193,7 @@ end
 
 
 @doc raw"""
-     is_transverse_intersection(C::S, D::S, P::AbsProjectiveRationalPoint) where S <: ProjectivePlaneCurve
+    is_transverse_intersection(C::S, D::S, P::AbsProjectiveRationalPoint) where S <: ProjectivePlaneCurve
 
 Return `true` if `C` and `D` intersect transversally at `P` and `false` otherwise.
 """

diff --git a/src/AlgebraicGeometry/Schemes/AffineSchemes/Objects/Attributes.jl b/src/AlgebraicGeometry/Schemes/AffineSchemes/Objects/Attributes.jl
@@ -521,7 +521,7 @@ end
 # TODO: projective schemes, covered schemes
 
 @doc raw"""
-   reduced_scheme(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
+    reduced_scheme(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
 
 Return the induced reduced scheme of `X`.
 

diff --git a/src/AlgebraicGeometry/Schemes/AffineSchemes/Objects/Properties.jl b/src/AlgebraicGeometry/Schemes/AffineSchemes/Objects/Properties.jl
@@ -527,7 +527,7 @@ end
 # TODO: projective schemes, covered schemes
 
 @doc raw"""
-   is_equidimensional(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
+    is_equidimensional(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
 
 Check whether the scheme `X` is equidimensional.
 
@@ -589,7 +589,7 @@ end
 # TODO: projective schemes
 
 @doc raw"""
-   is_reduced(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
+    is_reduced(X::AbsAffineScheme{<:Field, <:MPolyAnyRing})
 
 Check whether the affine scheme `X` is reduced.
 """
@@ -722,7 +722,7 @@ is_smooth(X::AbsAffineScheme{<:Field, <:MPolyLocRing}) = true
 #    irreducible = nilradical of OO(X) is prime                   #
 ###################################################################
 @doc raw"""
-   is_irreducible(X::AbsAffineScheme)
+    is_irreducible(X::AbsAffineScheme)
 
 Check whether the affine scheme `X` is irreducible.
 
@@ -741,7 +741,7 @@ is_irreducible(X::AbsAffineScheme{<:Field,<:MPolyRing}) = true
 is_irreducible(X::AbsAffineScheme{<:Field,<:MPolyLocRing}) = true
 
 @doc raw"""
-   is_integral(X::AbsAffineScheme)
+    is_integral(X::AbsAffineScheme)
 
 Check whether the affine scheme `X` is integral, i.e. irreducible and reduced.
 """
@@ -777,7 +777,7 @@ end
 # Connectedness                                                   #
 ###################################################################
 @doc raw"""
-   is_connected(X::AbsAffineScheme)
+    is_connected(X::AbsAffineScheme)
 
 Check whether the affine scheme `X` is connected.
 """

diff --git a/src/AlgebraicGeometry/Schemes/CoveredSchemes/Objects/Properties.jl b/src/AlgebraicGeometry/Schemes/CoveredSchemes/Objects/Properties.jl
@@ -8,7 +8,7 @@
 # (1) Check and store, whether a covered scheme is empty               #
 ########################################################################
 @doc raw"""
-   is_empty(X::AbsCoveredScheme)
+    is_empty(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is empty.
 
@@ -25,7 +25,7 @@ end
 # (2) Check and store, whether a covered scheme is smooth              #
 ########################################################################
 @doc raw"""
-   is_smooth(X::AbsCoveredScheme)
+    is_smooth(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is smooth.
 """
@@ -70,7 +70,7 @@ end
 #     i.e. irreducible and reduced                                     #
 ########################################################################
 @doc raw"""
-   is_integral(X::AbsCoveredScheme)
+    is_integral(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is integral.
 
@@ -85,7 +85,7 @@ end
 # Note: This does not work with gluing_graph, because empty patches
 #      need to be ignored without changing the covering
 @doc raw"""
-   is_connected_gluing(X::AbsCoveredScheme)
+    is_connected_gluing(X::AbsCoveredScheme)
 
 Return the boolean value whether the gluing graph of the default
 covering of the scheme X is connected.
@@ -102,7 +102,7 @@ end
 # (4) Check and store, whether a covered scheme is connected           #
 ########################################################################
 @doc raw"""
-   is_connected(X::AbsCoveredScheme)
+    is_connected(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is connected.
 
@@ -119,7 +119,7 @@ end
 # (5) Check and store, whether a scheme is reduced
 ##############################################################################
 @doc raw"""
-   is_reduced(X::AbsCoveredScheme)
+    is_reduced(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is reduced.
 
@@ -132,7 +132,7 @@ end
 # (6) Check and store, whether a covered scheme is irreducible
 ##############################################################################
 @doc raw"""
-   is_irreducible(X::AbsCoveredScheme)
+    is_irreducible(X::AbsCoveredScheme)
 
 Return the boolean value whether a covered scheme `X` is irreducible.
 

diff --git a/src/AlgebraicGeometry/Schemes/ProjectiveSchemes/Morphisms/Attributes.jl b/src/AlgebraicGeometry/Schemes/ProjectiveSchemes/Morphisms/Attributes.jl
@@ -12,7 +12,7 @@ underlying_morphism(f::AbsProjectiveSchemeMorphism) = error("no underlying morph
 domain(phi::ProjectiveSchemeMor) = phi.domain
 codomain(phi::ProjectiveSchemeMor) = phi.codomain
 @doc raw"""
-     pullback(phi::ProjectiveSchemeMor)
+    pullback(phi::ProjectiveSchemeMor)
 
 For a morphism `phi` of projective schemes, this returns the associated 
 morphism of graded affine algebras.

diff --git a/src/Combinatorics/PhylogeneticTrees.jl b/src/Combinatorics/PhylogeneticTrees.jl
@@ -43,7 +43,7 @@ function phylogenetic_tree(T::Type{<:Union{Float64, QQFieldElem}}, newick::Strin
 end
 
 @doc raw"""
-   phylogenetic_tree(M::Matrix{T}, taxa::Vector{String}) where T <: Union{Float64, QQFieldElem}
+    phylogenetic_tree(M::Matrix{T}, taxa::Vector{String}) where T <: Union{Float64, QQFieldElem}
 
 Constructs a phylogenetic tree with cophenetic matrix `M` and taxa `taxa`. The matrix `M` must be
 ultrametric, otherwise an error will be thrown.

diff --git a/src/Combinatorics/SimplicialComplexes.jl b/src/Combinatorics/SimplicialComplexes.jl
@@ -552,7 +552,7 @@ end
 ###############################################################################
 
 @doc raw"""
-     is_isomorphic(K1::SimplicialComplex, K2::SimplicialComplex)
+    is_isomorphic(K1::SimplicialComplex, K2::SimplicialComplex)
 
 Checks if the given simplicial complexes are isomorphic.
 

diff --git a/src/InvariantTheory/invariant_rings.jl b/src/InvariantTheory/invariant_rings.jl
@@ -219,7 +219,7 @@ function reynolds_operator(IR::InvRing{FldT, GrpT, PolyRingElemT}) where {FldT,
 end
 
 @doc raw"""
-     reynolds_operator(IR::InvRing{FldT, GrpT, T}, f::T) where {FldT, GrpT, T <: MPolyRingElem}
+    reynolds_operator(IR::InvRing{FldT, GrpT, T}, f::T) where {FldT, GrpT, T <: MPolyRingElem}
 
 In the non-modular case, return the image of `f` under the Reynolds operator
 projecting onto `IR`.
@@ -342,8 +342,8 @@ function reynolds_operator(IR::InvRing{FldT, GrpT, PolyRingElemT}, chi::GAPGroup
 end
 
 @doc raw"""
-     reynolds_operator(IR::InvRing{FldT, GrpT, T}, f::T, chi::GAPGroupClassFunction)
-       where {FldT, GrpT, T <: MPolyRingElem}
+    reynolds_operator(IR::InvRing{FldT, GrpT, T}, f::T, chi::GAPGroupClassFunction)
+      where {FldT, GrpT, T <: MPolyRingElem}
 
 In the case of characteristic zero, return the image of `f` under the twisted
 Reynolds operator projecting onto the isotypic component of the polynomial ring
@@ -412,7 +412,7 @@ end
 ################################################################################
 
 @doc raw"""
-     basis(IR::InvRing, d::Int, algorithm::Symbol = :default)
+    basis(IR::InvRing, d::Int, algorithm::Symbol = :default)
 
 Given an invariant ring `IR` and an integer `d`, return a basis for the invariants in degree `d`.
 

diff --git a/src/InvariantTheory/iterators.jl b/src/InvariantTheory/iterators.jl
@@ -168,7 +168,7 @@ function dimension_via_molien_series(::Type{T}, R::InvRing, d::Int, chi::Union{G
 end
 
 @doc raw"""
-     iterate_basis(IR::InvRing, d::Int, algorithm::Symbol = :default)
+    iterate_basis(IR::InvRing, d::Int, algorithm::Symbol = :default)
 
 Given an invariant ring `IR` and an integer `d`, return an iterator over a basis
 for the invariants in degree `d`.

diff --git a/src/Modules/homological-algebra.jl b/src/Modules/homological-algebra.jl
@@ -11,7 +11,7 @@
 ##############################################################################
 
 @doc raw"""
-     fitting_ideal(M::ModuleFP{T}, i::Int) where T <: MPolyRingElem 
+    fitting_ideal(M::ModuleFP{T}, i::Int) where T <: MPolyRingElem 
 
 Return the `i`-th Fitting ideal of `M`.
 
@@ -86,7 +86,7 @@ end
 ##############################################################################
 
 @doc raw"""
-     is_flat(M::ModuleFP{T}) where T <: MPolyRingElem 
+    is_flat(M::ModuleFP{T}) where T <: MPolyRingElem 
 
 Return `true` if `M` is flat, `false` otherwise.
 
@@ -141,7 +141,7 @@ function is_flat(M::SubquoModule{T}) where T <: MPolyRingElem
 end
 
 @doc raw"""
-     non_flat_locus(M::ModuleFP{T}) where T <: MPolyRingElem 
+    non_flat_locus(M::ModuleFP{T}) where T <: MPolyRingElem 
 
 Return an ideal of `base_ring(M)` which defines the non-flat-locus of `M`
 in the sense that the localization of `M` at a prime ideal of `base_ring(M)`
@@ -203,7 +203,7 @@ end
 ##############################################################################
 
 @doc raw"""
-     is_regular_sequence(V::Vector{T}, M::ModuleFP{T}) where T <: MPolyRingElem
+    is_regular_sequence(V::Vector{T}, M::ModuleFP{T}) where T <: MPolyRingElem
 
 Return `true` if the elements of `V` form, in the given order, a regular sequence on `M`.
 Return `false`, otherwise.
@@ -273,7 +273,7 @@ end
 ##############################################################################
 
 @doc raw"""
-     koszul_homology(V::Vector{T}, M::ModuleFP{T}, p::Int) where T <: MPolyRingElem
+    koszul_homology(V::Vector{T}, M::ModuleFP{T}, p::Int) where T <: MPolyRingElem
 
 If $f_1, \dots, f_r$ are the entries of `V` in the given order, return the `p`-th homology 
 module of the complex $K(f_1, \dots, f_r)\otimes_R M$, where $K(f_1, \dots, f_r)$ is the
@@ -428,7 +428,7 @@ end
 ##############################################################################
 
 @doc raw"""
-     depth(I::MPolyIdeal{T}, M::ModuleFP{T}) where T <: MPolyRingElem
+    depth(I::MPolyIdeal{T}, M::ModuleFP{T}) where T <: MPolyRingElem
 
 Return the depth of `I` on `M`.
 
@@ -572,7 +572,7 @@ end
 ##############################################################################
 
 @doc raw"""
-     koszul_matrix(V::Vector{T}, p::Int) where T <: MPolyRingElem
+    koszul_matrix(V::Vector{T}, p::Int) where T <: MPolyRingElem
 
 If $f_1, \dots, f_r$ are the entries of `V` in the given order, return the matrix representing
 the `p`-th map of the Koszul complex $K(f_1, \dots, f_r)$.
@@ -626,7 +626,7 @@ function _koszul_matrix_from_singular(V::Vector{T}, i::Int) where T <: MPolyRing
 end
 
 @doc raw"""
-     koszul_complex(V::Vector{T}) where T <: MPolyRingElem
+    koszul_complex(V::Vector{T}) where T <: MPolyRingElem
 
 If $f_1, \dots, f_r$ are the entries of `V` in the given order, return the Koszul complex $K(f_1, \dots, f_r)$.
 

diff --git a/src/PolyhedralGeometry/PolyhedralComplex/standard_constructions.jl b/src/PolyhedralGeometry/PolyhedralComplex/standard_constructions.jl
@@ -42,7 +42,7 @@ end
 
 
 @doc raw"""
-     k_skeleton(PC::PolyhedralComplex,k::Int)
+    k_skeleton(PC::PolyhedralComplex,k::Int)
 
 Return the k-skeleton of a polyhedral complex.
 

diff --git a/src/PolyhedralGeometry/Polyhedron/standard_constructions.jl b/src/PolyhedralGeometry/Polyhedron/standard_constructions.jl
@@ -2192,7 +2192,7 @@ function rand_normal_polytope(d::Int, n::Int; seed=nothing, precision=nothing)
 end
 
 @doc raw"""
-   rss_associahedron(n::Int)
+    rss_associahedron(n::Int)
 
 Produce a polytope of constrained expansions in ambient dimension `n` according to [RSS03](@cite).