Skip to content

Commit

Permalink
non canonical docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnoStrouwen committed Oct 14, 2023
1 parent d4239a7 commit bc93796
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/src/systems/DiscreteSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ DiscreteSystem

```@docs
DiscreteFunction(sys::ModelingToolkit.DiscreteSystem, args...)
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, args...)
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan)
```

## Expression Constructors
Expand Down
8 changes: 5 additions & 3 deletions docs/src/systems/JumpSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,17 @@ JumpSystem

## Transformations

```@docs
```@docs; canonical=false
structural_simplify
```

## Analyses

## Problem Constructors

```@docs; canonical=false
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan)
```
```@docs
SciMLBase.DiscreteProblem(sys::JumpSystem,args...)
JumpProcesses.JumpProblem(sys::JumpSystem,args...)
JumpProblem(sys::JumpSystem, prob, aggregator)
```
6 changes: 3 additions & 3 deletions docs/src/systems/NonlinearSystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,22 +15,22 @@ NonlinearSystem

## Transformations

```@docs
```@docs; canonical=false
structural_simplify
alias_elimination
tearing
```

## Analyses

```@docs
```@docs; canonical=false
ModelingToolkit.isaffine
ModelingToolkit.islinear
```

## Applicable Calculation and Generation Functions

```julia
```@docs; canonical=false
calculate_jacobian
generate_jacobian
jacobian_sparsity
Expand Down
4 changes: 2 additions & 2 deletions docs/src/systems/ODESystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ ModelingToolkit.isaffine

## Applicable Calculation and Generation Functions

```julia
```@docs; canonical=false
calculate_jacobian
calculate_tgrad
calculate_factorized_W
Expand All @@ -56,7 +56,7 @@ SteadyStateProblem(sys::ModelingToolkit.AbstractODESystem, args...)
## Torn Problem Constructors

```@docs
ODAEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
ODAEProblem
```

## Expression Constructors
Expand Down
8 changes: 5 additions & 3 deletions docs/src/systems/SDESystem.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,17 +22,19 @@ sde = SDESystem(ode, noiseeqs)

## Transformations

```@docs
```@docs; canonical=false
structural_simplify
alias_elimination
Girsanov_transform
```
```@docs
ModelingToolkit.Girsanov_transform
```

## Analyses

## Applicable Calculation and Generation Functions

```julia
```@docs; canonical=false
calculate_jacobian
calculate_tgrad
calculate_factorized_W
Expand Down

0 comments on commit bc93796

Please sign in to comment.