Add basic docs and fixup docstring

JuliaSymbolics · Mar 20, 2024 · 8983dad · 8983dad
1 parent 172c4b3
commit 8983dad
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 1 deletion.
diff --git a/docs/make.jl b/docs/make.jl
@@ -50,6 +50,7 @@ makedocs(
             "manual/sparsity_detection.md",
             "manual/types.md",
             "manual/faq.md"
+            "manual/limits.md"
         ],
         "Comparison Against SymPy" => "comparison.md",
     ]

diff --git a/docs/src/manual/limits.md b/docs/src/manual/limits.md
@@ -0,0 +1,8 @@
+# Symbolic Limits
+
+Experimental symbolic limit support is provided by the [`limit`](@ref) function, documented
+below.
+
+```@docs
+limit
+```
diff --git a/src/limits.jl b/src/limits.jl
@@ -11,7 +11,7 @@ thrown. Side defaults to `:both` for finite `h`, `:left` for `h = Inf`, and `:ri
 `expr` must be compoesed of `log`, `exp`, constants, and the rational opperators `+`, `-`,
 `*`, and `/`. This limitation may eventually be relaxed.
 
-!!! Warning
+!!! warning
     Because symbolic limit computation is undecidable, this function necessarily employs
     heuristics and may occasionally return wrong answers. Nevertheless, please report wrong
     answers as issues as we aim to have heuristics that produce correct answers in all