Skip to content

Add angle brackets around URLs in docstrings #1168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Nov 13, 2025
Merged

Add angle brackets around URLs in docstrings #1168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions src/scimlfunctions.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -478,7 +478,7 @@ the usage of the `SplitFunction`. These include:
- `mass_matrix`: the mass matrix `M` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -708,7 +708,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -813,7 +813,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M_i` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator. Should be given as a tuple
of mass matrices, i.e. `(M_1, M_2)` for the mass matrices of equations 1 and 2
respectively.
Expand Down Expand Up @@ -1030,7 +1030,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -1132,7 +1132,7 @@ are optional for improving or accelerating the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M` represented in the SDE function. Can be used
to determine that the equation is actually a stochastic differential-algebraic equation (SDAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/sdae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/sdae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -1247,7 +1247,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M_i` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator. Should be given as a tuple
of mass matrices, i.e. `(M_1, M_2)` for the mass matrices of equations 1 and 2
respectively.
Expand Down Expand Up @@ -1604,7 +1604,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator.
- `analytic(u0,p,t)`: used to pass an analytical solution function for the analytical
solution of the ODE. Generally only used for testing and development of the solvers.
Expand Down Expand Up @@ -2400,7 +2400,7 @@ the usage of `f`. These include:
- `mass_matrix`: the mass matrix `M_i` represented in the ODE function. Can be used
to determine that the equation is actually a differential-algebraic equation (DAE)
if `M` is singular. Note that in this case special solvers are required, see the
DAE solver page for more details: https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/.
DAE solver page for more details: <https://docs.sciml.ai/DiffEqDocs/stable/solvers/dae_solve/>.
Must be an AbstractArray or an AbstractSciMLOperator. Should be given as a tuple
of mass matrices, i.e. `(M_1, M_2)` for the mass matrices of equations 1 and 2
respectively.
Expand Down
Loading