Skip to content

Commit 8e29750

Browse files
fix docs typos
1 parent d1d8843 commit 8e29750

File tree

3 files changed

+11
-11
lines changed

3 files changed

+11
-11
lines changed

docs/src/systems/AbstractSystem.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ Below are the possible calculation and generation functions:
4545

4646
```@docs
4747
calculate_tgrad
48-
calculate_grad
48+
calculate_gradient
4949
calculate_jacobian
5050
calculate_factorized_W
5151
calculate_hessian
52-
generate_jacobian
53-
generate_grad
5452
generate_tgrad
53+
generate_gradient
54+
generate_jacobian
5555
generate_factorized_W
5656
generate_hessian
5757
```

docs/src/systems/OptimizationSystem.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,10 +17,10 @@ OptimizationSystem
1717
## Applicable Calculation and Generation Functions
1818

1919
```julia
20-
calculate_grad
21-
calculate_hes
22-
generate_grad
23-
generate_hes
20+
calculate_gradient
21+
calculate_hessian
22+
generate_gradient
23+
generate_hessian
2424
```
2525

2626
## Problem Constructors

src/systems/abstractsystem.jl

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,14 @@ call will be cached in the system object.
99
function calculate_tgrad end
1010

1111
"""
12-
calculate_grad(sys::AbstractSystem)
12+
calculate_gradient(sys::AbstractSystem)
1313
1414
Calculate the gradient of a scalar system.
1515
1616
Returns a vector of [`Expression`](@ref) instances. The result from the first
1717
call will be cached in the system object.
1818
"""
19-
function calculate_grad end
19+
function calculate_gradient end
2020

2121
"""
2222
calculate_jacobian(sys::AbstractSystem)
@@ -57,12 +57,12 @@ the arguments to the internal [`build_function`](@ref) call.
5757
function generate_tgrad end
5858

5959
"""
60-
generate_grad(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; kwargs...)
60+
generate_gradient(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; kwargs...)
6161
6262
Generates a function for the gradient of a system. Extra arguments control
6363
the arguments to the internal [`build_function`](@ref) call.
6464
"""
65-
function generate_grad end
65+
function generate_gradient end
6666

6767
"""
6868
generate_jacobian(sys::AbstractSystem, dvs = states(sys), ps = parameters(sys), expression = Val{true}; sparse = false, kwargs...)

0 commit comments

Comments
 (0)