Skip to content

docs: clarify number-to-time conversion in durations.adoc #211

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
henryw374 merged 2 commits into from
May 13, 2026
+27 −13
Merged

docs: clarify number-to-time conversion in durations.adoc #211

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f248600
docs: clarify number-to-time conversion in durations.adoc
SAY-5 May 10, 2026
a8950eb
docs: rebuild index.html for durations clarification
SAY-5 May 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs/durations.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,12 +66,14 @@ NOTE: TODO Don't forget you can create zone-offsets from durations!
NOTE: TODO Don't forget you can create instants from durations - this is often needed when you get Unix times (e.g. JWT OAuth2 tokens)

The problem with numeric times is that there are cases where the units
are in seconds and cases where milliseconds are used. If _tick_ were
to convert numbers to times, it would be a source of confusion and
bugs if the units were not clear. For this reason, you cannot convert
numbers to times. However, you can first create the duration from the
number, specifying the units explicitly, and then convert the duration
to an `instant` (or `inst`).
are in seconds and cases where milliseconds are used. To avoid ambiguity
about the units, the recommended approach is to first create the duration
from the number, specifying the units explicitly, and then convert the
duration to an `instant` (or `inst`).

NOTE: `t/instant` does accept a bare number for convenience, treating it
as epoch milliseconds. The duration-based form below is preferred because
the units are explicit.

[source.code,clojure]
----
Expand Down
26 changes: 19 additions & 7 deletions docs/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="Asciidoctor 2.0.18">
<meta name="generator" content="Asciidoctor 2.0.26">
<meta name="author" content="Malcolm Sparks, Henry Widd, Johanna Antonelli">
<link rel="icon" type="image/x-icon" href="favicon.ico">
<title>tick</title>
Expand Down Expand Up @@ -2212,12 +2212,24 @@ <h3 id="_misc">5.4. Misc</h3>
</div>
<div class="paragraph">
<p>The problem with numeric times is that there are cases where the units
are in seconds and cases where milliseconds are used. If <em>tick</em> were
to convert numbers to times, it would be a source of confusion and
bugs if the units were not clear. For this reason, you cannot convert
numbers to times. However, you can first create the duration from the
number, specifying the units explicitly, and then convert the duration
to an <code>instant</code> (or <code>inst</code>).</p>
are in seconds and cases where milliseconds are used. To avoid ambiguity
about the units, the recommended approach is to first create the duration
from the number, specifying the units explicitly, and then convert the
duration to an <code>instant</code> (or <code>inst</code>).</p>
</div>
<div class="admonitionblock note">
<table>
<tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<code>t/instant</code> does accept a bare number for convenience, treating it
as epoch milliseconds. The duration-based form below is preferred because
the units are explicit.
</td>
</tr>
</table>
</div>
<div class="listingblock code">
<div class="content">
Expand Down
Loading