Skip to content

Commit

Permalink
docs: update documentation for symbolic_container
Browse files Browse the repository at this point in the history
  • Loading branch information
AayushSabharwal committed Jul 24, 2024
1 parent 40daf4e commit 1f22a45
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/src/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
### Mandatory methods

```@docs
symbolic_container
is_variable
variable_index
variable_symbols
Expand All @@ -26,6 +25,10 @@ allvariables

### Optional Methods

```@docs
symbolic_container
```

#### Observed equation handling

```@docs
Expand Down
5 changes: 5 additions & 0 deletions src/index_provider_interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ Using `indp`, return an object that implements the index provider interface. In
itself implements the interface, `indp` can be returned as-is. All index provider interface
methods fall back to calling the same method on `symbolic_container(indp)`, so this may be
used for trivial implementations of the interface that forward all calls to another object.
Note that this method is optional. Thus the correct method to check for a fallback is:
```julia
hasmethod(symbolic_container, Tuple{typeof(indp)}) && symbolic_container(indp) != indp
```
"""
function symbolic_container end

Expand Down

0 comments on commit 1f22a45

Please sign in to comment.