From 71787578e3c78f88b34f0e6f48414b50167b2cec Mon Sep 17 00:00:00 2001 From: Matteo Foglieni <79974922+cosmofico97@users.noreply.github.com> Date: Mon, 19 Feb 2024 18:26:42 +0100 Subject: [PATCH] correcting docs --- .github/workflows/UnitTests.yml | 8 ++++---- docs/src/MathUtils.md | 4 ++-- src/MathUtils.jl | 6 +++--- 3 files changed, 9 insertions(+), 9 deletions(-) diff --git a/.github/workflows/UnitTests.yml b/.github/workflows/UnitTests.yml index 541ef705..07395cde 100644 --- a/.github/workflows/UnitTests.yml +++ b/.github/workflows/UnitTests.yml @@ -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: diff --git a/docs/src/MathUtils.md b/docs/src/MathUtils.md index d4f1527b..5098beb1 100644 --- a/docs/src/MathUtils.md +++ b/docs/src/MathUtils.md @@ -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 diff --git a/src/MathUtils.jl b/src/MathUtils.jl index 1ffe0b7a..e8f0e22c 100644 --- a/src/MathUtils.jl +++ b/src/MathUtils.jl @@ -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) @@ -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!" @@ -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)