From a0bf1fa84f29877cf91f1f32df8892dfbaa875da Mon Sep 17 00:00:00 2001 From: a Date: Wed, 5 Jun 2024 12:39:40 +0100 Subject: [PATCH 1/2] update readme (trigger doc build) --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index e63d181..bc8d2cf 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,4 @@ Its purpose is to provide a shared interface between various symbolic programmin ## Docs -[Read the documentation here.](https://juliasymbolics.github.io/TermInterface.jl/dev/) \ No newline at end of file +[You can read the documentation here.](https://juliasymbolics.github.io/TermInterface.jl/dev/) \ No newline at end of file From b4819e085961003848ebc136816eae8b76a2fecf Mon Sep 17 00:00:00 2001 From: a Date: Wed, 5 Jun 2024 12:41:44 +0100 Subject: [PATCH 2/2] adjust doc rendering --- src/TermInterface.jl | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/TermInterface.jl b/src/TermInterface.jl index c229c8a..ca28b68 100644 --- a/src/TermInterface.jl +++ b/src/TermInterface.jl @@ -56,7 +56,7 @@ function children end export children """ - operation(x) + operation(x) Returns the function a function call expression is calling. `iscall(x)` must be true as a precondition. @@ -65,7 +65,7 @@ function operation end export operation """ - arguments(x) + arguments(x) Returns the arguments to the function call in a function call expression. `iscall(x)` must be true as a precondition. @@ -74,7 +74,7 @@ function arguments end export arguments """ - unsorted_arguments(x::T) + unsorted_arguments(x::T) If x is a expression satisfying `iscall(x)` and your expression type `T` provides and optimized implementation for storing the arguments, this function can @@ -86,7 +86,7 @@ export unsorted_arguments """ - arity(x) + arity(x) When `x` satisfies `iscall`, returns the number of arguments of `x`. Implicitly defined if `arguments(x)` is defined. @@ -96,7 +96,7 @@ export arity """ - metadata(x) + metadata(x) Returns the metadata attached to `x`. """ @@ -105,7 +105,7 @@ export metadata """ - metadata(expr, md) + metadata(expr, md) Returns a `expr` with metadata `md` attached to it. """