Skip to content

Commit 4284270

Browse files
committed
Docs: Use @docs to automatically generate doc
1 parent 993a3bd commit 4284270

File tree

1 file changed

+5
-17
lines changed

1 file changed

+5
-17
lines changed

docs/src/manual/interface.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -13,20 +13,8 @@ You can read the documentation of [TermInterface.jl](https://github.com/JuliaSym
1313

1414
## SymbolicUtils.jl only methods
1515

16-
### `symtype(x)`
17-
18-
Returns the
19-
[numeric type](https://docs.julialang.org/en/v1/base/numbers/#Standard-Numeric-Types)
20-
of `x`. By default this is just `typeof(x)`.
21-
Define this for your symbolic types if you want [`SymbolicUtils.simplify`](@ref) to apply rules
22-
specific to numbers (such as commutativity of multiplication). Or such
23-
rules that may be implemented in the future.
24-
25-
### `issym(x)`
26-
27-
Returns `true` if `x` is a `Sym`. If `true`, `nameof` must be defined
28-
on `x` and must return a `Symbol`.
29-
30-
### `promote_symtype(f, arg_symtypes...)`
31-
32-
Returns the appropriate output type of applying `f` on arguments of type `arg_symtypes`.
16+
```@docs
17+
symtype
18+
issym
19+
promote_symtype
20+
```

0 commit comments

Comments
 (0)