fix: vertices documentation and references

oscar-system · Aug 14, 2024 · 7b5e034 · lgoettgens · Aug 14, 2024 · YueRen
1 parent 112b83b
commit 7b5e034
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/docs/src/PolyhedralGeometry/polyhedral_complexes.md b/docs/src/PolyhedralGeometry/polyhedral_complexes.md
@@ -48,6 +48,6 @@ n_vertices(PC::PolyhedralComplex)
 polyhedra_of_dim
 rays(PC::PolyhedralComplex{T}) where T<:scalar_types
 rays_modulo_lineality(PC::PolyhedralComplex{T}) where T<:scalar_types
-vertices(PC::PolyhedralComplex)
+vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}
 vertices_and_rays(PC::PolyhedralComplex{T}) where T<:scalar_types
 ```
diff --git a/src/PolyhedralGeometry/PolyhedralComplex/properties.jl b/src/PolyhedralGeometry/PolyhedralComplex/properties.jl
@@ -28,7 +28,7 @@ julia> ambient_dim(PC)
 ambient_dim(PC::PolyhedralComplex) = Polymake.fan.ambient_dim(pm_object(PC))::Int
 
 @doc raw"""
-    vertices([as::Type{T} = PointVector,] PC::PolyhedralComplex)
+    vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}
 
 Return an iterator over the vertices of `PC` in the format defined by `as`. The
 vertices are defined to be the zero-dimensional faces, so if `P` has lineality,
@@ -253,7 +253,7 @@ translation `p+L`, where `p` is only unique modulo `L`. The return type is a
 dict, the key `:base_points` gives an iterator over such `p`, and the key
 `:lineality_basis` lets one access a basis for the lineality space `L` of `PC`.
 
-See also [`vertices`](@ref) and [`lineality_space`](@ref).
+See also [`vertices(as::Type{PointVector{T}}, PC::PolyhedralComplex{T}) where {T<:scalar_types}`](@ref) and [`lineality_space`](@ref).
 
 # Examples
 ```jldoctest