Documentation update (#16)

* Update documentation for solve function and add one for steady_state_K * Bind steady_state_K documentation * Change public function call * Use LaTeX --------- Co-authored-by: Michał Dobranowski <mdbrnowski@gmail.com>
mdbrnowski · Jun 5, 2024 · 73b3e0a · 73b3e0a
1 parent be4cdcc
commit 73b3e0a
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 5 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,6 +1,6 @@
 name = "RamseyGrowthModel"
 uuid = "d3b58844-8b75-44dd-9e60-01c7b9b67cff"
-authors = ["Michał Dobranowski <mdbrnowski@gmail.com>"]
+authors = ["Michał Dobranowski <mdbrnowski@gmail.com>", "Joanna Konieczny <joanna.konieczny.contact@gmail.com>"]
 version = "0.1.0"
 
 [deps]

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -29,6 +29,10 @@ print(allocation)
 GrowthModel
 ```
 
+```@docs
+RamseyGrowthModel.steady_state_K
+```
+
 ```@docs
 solve
 ```

diff --git a/example.jl b/example.jl
@@ -85,7 +85,7 @@ With the increase of time ``T``, a special property of the capital function can
 """
 
 # ╔═╡ 69167b33-034d-480b-9a06-193c11c61c49
-kss = RamseyGrowthModel.steady_state_K(my_model)
+kss = steady_state_K(my_model)
 
 # ╔═╡ 77398e1c-55a3-4ae7-868a-cdb7cdf2a8f2
 kss_best_allocation = solve(my_model, 100, kss)
@@ -168,7 +168,7 @@ md"""
 custom_allocation = solve(custom_model, t, k_0/10)
 
 # ╔═╡ 8214f1e7-f8ad-44ef-9be7-ec5b930e399d
-custom_kss = RamseyGrowthModel.steady_state_K(custom_model)
+custom_kss = steady_state_K(custom_model)
 
 # ╔═╡ f4e715da-809f-42e5-a948-f8d4de5e297e
 plot_capital(custom_allocation, custom_kss)

diff --git a/src/RamseyGrowthModel.jl b/src/RamseyGrowthModel.jl
@@ -1,6 +1,6 @@
 module RamseyGrowthModel
 
-export GrowthModel, solve
+export GrowthModel, solve, steady_state_K
 
 using DataFrames
 using ForwardDiff
@@ -83,6 +83,19 @@ function shooting(model::GrowthModel, T::Integer, K₀::Real, C₀::Real)::DataF
     allocation
 end
 
+@doc raw"""
+Returns steady state capital ``K``, to which capital ``K_t`` converges for large values of ``T``.
+
+```julia
+steady_state_K(model::GrowthModel)
+```
+
+# Arguments
+
+* `model` - previously defined growth model
+
+This value is mostly useful for plotting purposes and as a starting point of a simulation.
+"""
 function steady_state_K(model::GrowthModel)::Real
     f′(k::Real) = ForwardDiff.derivative(model.f, k)
     find_zero(x -> f′(x) - 1 / model.β + 1 - model.δ, (0, Inf64))
@@ -92,7 +105,7 @@ end
 Returns the best possible capital and consumption allocation (as a DataFrame).
 
 ```julia
-solve(model::GrowthModel, T::Integer, K₀::Real; kwargs...)
+solve(model::GrowthModel, T::Union{Integer,typeof(Inf)}, K₀::Real; kwargs...)
 ```
 
 # Arguments
@@ -101,6 +114,8 @@ solve(model::GrowthModel, T::Integer, K₀::Real; kwargs...)
 * `T` - considered time horizon
 * `K₀` - initial capital
 
+Argument `T` should be of type `Integer` or equal to `Inf`. Passing a floating point value will raise an error.
+
 # Keyword Arguments
 
 The algorithm uses a binary search; if you want, you can override the default maximum number of iterations (`max_iter=1000`) or error tolerance (`tol=K₀/1e6`).