introduces documentation for dimension

ederc · ederc · commit 88db99e5de88 · 2024-09-27T21:15:15.000+02:00
diff --git a/docs/make.jl b/docs/make.jl
@@ -21,6 +21,7 @@ makedocs(
         "types.md",
         "Algorithms" => ["groebner-bases.md",
                          "normal-forms.md",
+                         "dimension.md",
                          "solvers.md"],
         "Examples" => "katsura.md"
         ]
diff --git a/src/algorithms/dimension.jl b/src/algorithms/dimension.jl
@@ -3,7 +3,7 @@
 
 Compute the Krull dimension of a given polynomial ideal `I`.
 
-**Note**: This requires a Gröbner basis of `I`. 
+**Note**: This requires a Gröbner basis of `I`, which is computed internally if not alraedy known.
 
 # Examples
 ```jldoctest

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ makedocs(`
`21`	`21`	`"types.md",`
`22`	`22`	`"Algorithms" => ["groebner-bases.md",`
`23`	`23`	`"normal-forms.md",`
	`24`	`+ "dimension.md",`
`24`	`25`	`"solvers.md"],`
`25`	`26`	`"Examples" => "katsura.md"`
`26`	`27`	`]`