Internal docs

scheinerman · Feb 7, 2025 · c5a03c6 · c5a03c6
1 parent 51bf137
commit c5a03c6
Showing 1 changed file with 10 additions and 1 deletion.
diff --git a/src/Matroids.jl b/src/Matroids.jl
@@ -24,10 +24,19 @@ export AbstractRankFunction,
 
 include("RankFunctions.jl")
 
+"""
+Create a `Matroid` as follows:
+* `Matroid(m::Int, r::AbstractRankFunction)` given the number of elements and a rank function.
+* `Matroid(A::AbstractMatrix)` given a matrix.
+* `Matroid(g::Graph)` given a graph.
+* `Matroid()` yields the matroid with no elements. 
+
+See also: `UniformMatroid`.
+"""
 struct Matroid
     m::Int
     r::AbstractRankFunction
-    function Matroid(mm::Int, rr::AbstractRankFunction)
+    function Matroid(mm::T, rr::AbstractRankFunction) where {T<:Integer}
         return new(mm, rr)
     end
     function Matroid(A::AbstractMatrix)