Skip to content

Commit

Permalink
Fix typo in docs #4 (#4)
Browse files Browse the repository at this point in the history
Co-authored-by: gzelentsov <[email protected]>
  • Loading branch information
germanzelentsov and germanzelentsov authored Jun 14, 2024
1 parent d828416 commit 9e745bd
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -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"
Expand Down
10 changes: 5 additions & 5 deletions src/interface.jl
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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)
```
"""
Expand Down Expand Up @@ -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.
Expand Down

2 comments on commit 9e745bd

@gryumov
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register()

Release notes:

Fix typo in docs

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/109038

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v1.0.1 -m "<description of version>" 9e745bd19e7d707b9088cf414a673bd119a3996e
git push origin v1.0.1

Please sign in to comment.