Skip to content

Commit

Permalink
add correct stuff in docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Datseris committed Feb 11, 2024
1 parent 05ec0c3 commit 4daf8a2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 4 deletions.
2 changes: 0 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,8 +163,6 @@ This API describes how you can implement your own `Process` subtype, if the [exi

```@docs
Process
rhs
timescale
NoTimeDerivative
```

Expand Down
4 changes: 2 additions & 2 deletions src/API.jl
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
"""
A process subtype `p::Process` extends the functions:
A process subtype `p::Process` extends the `ProcessBasedModelling` unexported functions:
- `lhs_variable(p)` which returns the variable the process describes
(left-hand-side variable). There is a default implementation
`lhs_variable(p) = p.variable` if the field exists.
Expand All @@ -19,7 +19,7 @@ abstract type Process end
"""
NoTimeDerivative()
Singleton value that is the default output of the [`timescale`](@ref) function
Singleton value that is the default output of the `timescale` function
for variables that do not vary in time autonomously, i.e., they have no d/dt derivative
and hence the concept of a "timescale" does not apply to them.
"""
Expand Down

0 comments on commit 4daf8a2

Please sign in to comment.