Skip to content

Commit 0ef0bb4

Browse files
Merge pull request #2315 from ArnoStrouwen/docs
non canon docstrings
2 parents d4239a7 + b54b05b commit 0ef0bb4

File tree

6 files changed

+23
-16
lines changed

6 files changed

+23
-16
lines changed

docs/src/index.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -173,13 +173,16 @@ system:
173173

174174
- Please refer to the
175175
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
176-
for guidance on PRs, issues, and other matters relating to contributing to ModelingToolkit.
176+
for guidance on PRs, issues, and other matters relating to contributing to SciML.
177177

178+
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
178179
- There are a few community forums:
179180

180-
+ The #diffeq-bridged channel in the [Julia Slack](https://julialang.org/slack/)
181-
+ [JuliaDiffEq](https://gitter.im/JuliaDiffEq/Lobby) on Gitter
182-
+ On the Julia Discourse forums (look for the [modelingtoolkit tag](https://discourse.julialang.org/tag/modelingtoolkit))
181+
+ The #diffeq-bridged and #sciml-bridged channels in the
182+
[Julia Slack](https://julialang.org/slack/)
183+
+ The #diffeq-bridged and #sciml-bridged channels in the
184+
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
185+
+ On the [Julia Discourse forums](https://discourse.julialang.org)
183186
+ See also [SciML Community page](https://sciml.ai/community/)
184187

185188
## Reproducibility

docs/src/systems/DiscreteSystem.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ DiscreteSystem
2323

2424
```@docs
2525
DiscreteFunction(sys::ModelingToolkit.DiscreteSystem, args...)
26-
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, args...)
26+
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan)
2727
```
2828

2929
## Expression Constructors

docs/src/systems/JumpSystem.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,17 @@ JumpSystem
1515

1616
## Transformations
1717

18-
```@docs
18+
```@docs; canonical=false
1919
structural_simplify
2020
```
2121

2222
## Analyses
2323

2424
## Problem Constructors
2525

26+
```@docs; canonical=false
27+
DiscreteProblem(sys::ModelingToolkit.DiscreteSystem, u0map, tspan)
28+
```
2629
```@docs
27-
SciMLBase.DiscreteProblem(sys::JumpSystem,args...)
28-
JumpProcesses.JumpProblem(sys::JumpSystem,args...)
30+
JumpProblem(sys::JumpSystem, prob, aggregator)
2931
```

docs/src/systems/NonlinearSystem.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,22 +15,22 @@ NonlinearSystem
1515

1616
## Transformations
1717

18-
```@docs
18+
```@docs; canonical=false
1919
structural_simplify
2020
alias_elimination
2121
tearing
2222
```
2323

2424
## Analyses
2525

26-
```@docs
26+
```@docs; canonical=false
2727
ModelingToolkit.isaffine
2828
ModelingToolkit.islinear
2929
```
3030

3131
## Applicable Calculation and Generation Functions
3232

33-
```julia
33+
```@docs; canonical=false
3434
calculate_jacobian
3535
generate_jacobian
3636
jacobian_sparsity

docs/src/systems/ODESystem.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ ModelingToolkit.isaffine
3535

3636
## Applicable Calculation and Generation Functions
3737

38-
```julia
38+
```@docs; canonical=false
3939
calculate_jacobian
4040
calculate_tgrad
4141
calculate_factorized_W
@@ -56,7 +56,7 @@ SteadyStateProblem(sys::ModelingToolkit.AbstractODESystem, args...)
5656
## Torn Problem Constructors
5757

5858
```@docs
59-
ODAEProblem(sys::ModelingToolkit.AbstractODESystem, args...)
59+
ODAEProblem
6060
```
6161

6262
## Expression Constructors

docs/src/systems/SDESystem.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,17 +22,19 @@ sde = SDESystem(ode, noiseeqs)
2222

2323
## Transformations
2424

25-
```@docs
25+
```@docs; canonical=false
2626
structural_simplify
2727
alias_elimination
28-
Girsanov_transform
28+
```
29+
```@docs
30+
ModelingToolkit.Girsanov_transform
2931
```
3032

3133
## Analyses
3234

3335
## Applicable Calculation and Generation Functions
3436

35-
```julia
37+
```@docs; canonical=false
3638
calculate_jacobian
3739
calculate_tgrad
3840
calculate_factorized_W

0 commit comments

Comments
 (0)