Skip to content

Commit

Permalink
correcting docs
Browse files Browse the repository at this point in the history
  • Loading branch information
foglienimatteo committed Feb 19, 2024
1 parent 4a21680 commit 7178757
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions .github/workflows/UnitTests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@

name: Unit tests

#on: [push]
on: [push]

on:
release:
types: [published, edited, prereleased, released]
#on:
# release:
# types: [published, edited, prereleased, released]

#on:
# push:
Expand Down
4 changes: 2 additions & 2 deletions docs/src/MathUtils.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ GaPSE.power_law_from_data
GaPSE.polynomial_from_data
GaPSE.polynomial
GaPSE.expanded_left_log
GaPSE.expanded_right_log
GaPSE.expand_left_log
GaPSE.expand_right_log
GaPSE.expanded_IPS
GaPSE.expanded_Iln
GaPSE.func_I04_tilde
Expand Down
6 changes: 3 additions & 3 deletions src/MathUtils.jl
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Return the derivative in `(xp, yp)`, given the neighboor points
It is not assumed that `x2 - xp = xp - x1`.
See also: [`derivate_vector`](ref), [`spectral_index`](ref)]
See also: [`derivate_vector`](@ref), [`spectral_index`](@ref)]
"""
function derivate_point(xp, yp, x1, y1, x2, y2)
l2, l1 = (x2 - xp), (xp - x1)
Expand All @@ -44,7 +44,7 @@ end
Apply `derivate_point` to the vector.
`N::Int=1` is the number of points at each edge that idk.
See also: [`derivate_point`](ref), [`spectral_index`](ref)]
See also: [`derivate_point`](@ref), [`spectral_index`](@ref)]
"""
function derivate_vector(XS, YS; N::Int=1)
@assert length(XS) == length(YS) "xs and ys must have the same length!"
Expand Down Expand Up @@ -87,7 +87,7 @@ defined as:
= \\frac{x}{f(x)} \\frac{\\partial f(x)}{\\partial x}
```
See also: [`derivate_point`](ref), [`derivate_vector`](ref)
See also: [`derivate_point`](@ref), [`derivate_vector`](@ref)
"""
function spectral_index(xs, ys; N::Int=1, con=false)
derivs = derivate_vector(xs, ys; N=N)
Expand Down

0 comments on commit 7178757

Please sign in to comment.