From 8983dad505f07d20a02eb4edaf1e6873bc1a4c8c Mon Sep 17 00:00:00 2001 From: Lilith Orion Hafner Date: Wed, 20 Mar 2024 17:58:25 -0500 Subject: [PATCH] Add basic docs and fixup docstring --- docs/make.jl | 1 + docs/src/manual/limits.md | 8 ++++++++ src/limits.jl | 2 +- 3 files changed, 10 insertions(+), 1 deletion(-) create mode 100644 docs/src/manual/limits.md diff --git a/docs/make.jl b/docs/make.jl index 62f8c657d..641d892a5 100644 --- 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 new file mode 100644 index 000000000..e164c6d8d --- /dev/null +++ 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 index 89b1172f6..e61ee3670 100644 --- 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