Skip to content

ale/makedocs #43

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2024
Merged

ale/makedocs #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a0bf1fa
update readme (trigger doc build)
Jun 5, 2024
b4819e0
adjust doc rendering
Jun 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
[You can read the documentation here.](https://juliasymbolics.github.io/TermInterface.jl/dev/)
12 changes: 6 additions & 6 deletions src/TermInterface.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -96,7 +96,7 @@ export arity


"""
metadata(x)
metadata(x)

Returns the metadata attached to `x`.
"""
Expand All @@ -105,7 +105,7 @@ export metadata


"""
metadata(expr, md)
metadata(expr, md)

Returns a `expr` with metadata `md` attached to it.
"""
Expand Down
Loading