From 9e745bd19e7d707b9088cf414a673bd119a3996e Mon Sep 17 00:00:00 2001 From: germanzelentsov <84569060+germanzelentsov@users.noreply.github.com> Date: Fri, 14 Jun 2024 23:34:11 +0300 Subject: [PATCH] Fix typo in docs #4 (#4) Co-authored-by: gzelentsov --- Project.toml | 2 +- src/interface.jl | 10 +++++----- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/Project.toml b/Project.toml index 4539f0c..02abf1c 100644 --- a/Project.toml +++ b/Project.toml @@ -1,6 +1,6 @@ name = "TimeArrays" uuid = "058eeebf-2231-41de-8410-62311c15f51e" -version = "1.0.0" +version = "1.0.1" [deps] Dates = "ade2ca70-3891-5945-98fb-dc099432e06a" diff --git a/src/interface.jl b/src/interface.jl index 1b3fdb7..340eac6 100644 --- a/src/interface.jl +++ b/src/interface.jl @@ -5,7 +5,7 @@ """ AbstractTick{T,V} -Supertype for `TimeTick{T,V}` with timestmap of type `T` and value of type `V`. +Supertype for `TimeTick{T,V}` with timestamp of type `T` and value of type `V`. """ abstract type AbstractTick{T,V} end @@ -99,10 +99,10 @@ Constructs a [`TimeTick`](@ref) object from named tuple `x` which contains the t ```jldoctest julia> using Dates -julia> TimeTick{Date,Float64}((timestmap = DateTime("2024-01-01T00:00:00"), value = 100)) +julia> TimeTick{Date,Float64}((timestamp = DateTime("2024-01-01T00:00:00"), value = 100)) TimeTick(2024-01-01, 100.0) -julia> TimeTick((timestmap = DateTime("2024-01-01T00:00:00"), value = 100)) +julia> TimeTick((timestamp = DateTime("2024-01-01T00:00:00"), value = 100)) TimeTick(2024-01-01T00:00:00, 100) ``` """ @@ -201,14 +201,14 @@ end """ AbstractTimeArray{T,V} <: AbstractVector{TimeTick{T,V}} -Supertype for `TimeArray{T,V}` with timestmaps of type `T` and values of type `V`. +Supertype for `TimeArray{T,V}` with timestamps of type `T` and values of type `V`. """ abstract type AbstractTimeArray{T,V} <: AbstractVector{TimeTick{T,V}} end """ TimeArray{T,V} <: AbstractTimeArray{T,V} -Type describing a time series with timestmaps of type `T` and values of type `V`. +Type describing a time series with timestamps of type `T` and values of type `V`. ## Fields - `values::Vector{TimeTick{T,V}}`: Elements of a time series.