Skip to content

Commit

Permalink
Merge pull request #43 from JuliaSymbolics/ale/makedocs
Browse files Browse the repository at this point in the history
ale/makedocs
  • Loading branch information
0x0f0f0f authored Jun 5, 2024
2 parents a6b54d9 + b4819e0 commit ad7e667
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
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
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

4 comments on commit ad7e667

@0x0f0f0f
Copy link
Member Author

@0x0f0f0f 0x0f0f0f commented on ad7e667 Jun 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

  • Added deployed docs, adjusted docstrings.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Error while trying to register: Action not recognized: Register

@0x0f0f0f
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Added deployed docs, adjusted docstrings.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/108306

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.1 -m "<description of version>" ad7e66722abf99ede3e932fd21bac6612c41a5fb
git push origin v1.0.1

Please sign in to comment.