Skip to content

Commit

Permalink
Fix docs (#48)
Browse files Browse the repository at this point in the history
* Fix docs

* Fix formatting
  • Loading branch information
tpgillam authored Dec 31, 2023
1 parent e9574ff commit a44d297
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 6 additions & 4 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,15 @@ timezone_at

## Implementation details

### Artifact
### Artifacts

This module is based upon OpenStreetMap data, which has been compiled into shape files by [timezone-boundary-builder](https://github.com/evansiroky/timezone-boundary-builder).
We define an [Artifact](https://pkgdocs.julialang.org/v1/artifacts/) for each release (since `2021c`) of these raw JSON shape files.
We define an [Artifact](https://pkgdocs.julialang.org/v1/artifacts/) on-demand for each release (since `2018d`) of these raw JSON shape files.

When a new upstream release is made, a new artifact will be created by a package maintainer.
Refer to the [artifact_build](https://github.com/tpgillam/TimeZoneFinder.jl/tree/main/artifact_build) directory for a helper script.
Artifacts are created if and when the user requests a particular version of the time zone boundaries.
Whilst we might want to directly define artifacts pointing at the timezone-boundary-builder releases, we cannot.
This is because the `Artifacts` module only supports `.tar.gz`, and the official releases uses `.zip`.
Therefore, we follow [this pattern](https://pkgdocs.julialang.org/v1/artifacts/#Using-Artifacts) for defining new artifacts at runtime.

### Parsed cache

Expand Down
6 changes: 3 additions & 3 deletions src/TimeZoneFinder.jl
Original file line number Diff line number Diff line change
Expand Up @@ -286,9 +286,9 @@ julia> timezones_at(69.8, -141)
There are two possible reasons for this:
1. There were no boundary changes in a tzdata release, which means that there will
never be a boundary release for this particular version.
2. The boundary dataset is not yet available for a new tzdata release.
1. There were no boundary changes in a tzdata release, which means that there will
never be a boundary release for this particular version.
2. The boundary dataset is not yet available for a new tzdata release.
"""
function timezones_at(latitude, longitude)
version = _timezone_boundary_builder_version()
Expand Down

0 comments on commit a44d297

Please sign in to comment.