Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Mar 22, 2024
1 parent 9a950cd commit 3d95b5c
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Expand Up @@ -9,14 +9,11 @@ This is a small library useful for time duration humanization.
## HUMANIZE-DURATION ASDF System Details

* Description: Provides [`humanize-duration:humanize-duration`][74ec] function to make readable representation of `LOCAL-TIME-DURATION:DURATION` objects.

* Licence: Unlicense

* Author: Alexander Artemenko

* Homepage: [https://40ants.com/humanize-duration/][a0c4]

* Source control: [GIT][9168]
* Depends on: [40ants-doc][2c00], [docs-config][ce67], [local-time-duration][6422], [with-output-to-stream][9201]

<a id="x-28HUMANIZE-DURATION-3A-3A-40INTRO-2040ANTS-DOC-2FLOCATIVES-3ASECTION-29"></a>

Expand Down Expand Up @@ -61,7 +58,7 @@ Main job is done at `humanize-duration` ([`1`][74ec] [`2`][ffe3]):

<a id="x-28HUMANIZE-DURATION-3AHUMANIZE-DURATION-20FUNCTION-29"></a>

### [function](ee68) `humanize-duration:humanize-duration` duration &key stream (n-parts 2) (format-part #'default-format-part)
### [function](d174) `humanize-duration:humanize-duration` duration &key stream (n-parts 2) (format-part #'default-format-part)

This is the better version of `LOCAL-TIME-DURATION:HUMAN-READABLE-DURATION`.

Expand Down Expand Up @@ -90,12 +87,11 @@ your own version. This could be useful if you want to support localization to ot

<a id="x-28HUMANIZE-DURATION-3ADEFAULT-FORMAT-PART-20FUNCTION-29"></a>

### [function](e77d) `humanize-duration:default-format-part` stream part-type part
### [function](923d) `humanize-duration:default-format-part` stream part-type part

This is should return a string with propertly pluralized form.

* `PART-TYPE` argument is a member of (list :weeks :days :hours :minutes :secs :nsecs).

* `PART` is an integer.

Here are possible results:
Expand All @@ -121,7 +117,7 @@ This package includes a single function, useful to display duration in Russian l

<a id="x-28HUMANIZE-DURATION-2FRU-3AFORMAT-PART-20FUNCTION-29"></a>

#### [function](23d1) `humanize-duration/ru:format-part` stream part-type part
#### [function](e926) `humanize-duration/ru:format-part` stream part-type part

This is Russian version of part formatter for [`humanize-duration`][ffe3]

Expand Down Expand Up @@ -220,9 +216,13 @@ CL-USER> (flet ((p (n)
[d084]: https://40ants.com/humanize-duration/#x-28HUMANIZE-DURATION-3ADEFAULT-FORMAT-PART-20FUNCTION-29
[74ec]: https://40ants.com/humanize-duration/#x-28HUMANIZE-DURATION-3AHUMANIZE-DURATION-20FUNCTION-29
[9168]: https://github.com/40ants/humanize-duration
[ee68]: https://github.com/40ants/humanize-duration/blob/7c9de59fd9825b69f9df3c6058f1ccec0d18cfeb/src/core.lisp#L116
[e77d]: https://github.com/40ants/humanize-duration/blob/7c9de59fd9825b69f9df3c6058f1ccec0d18cfeb/src/core.lisp#L95
[23d1]: https://github.com/40ants/humanize-duration/blob/7c9de59fd9825b69f9df3c6058f1ccec0d18cfeb/src/ru.lisp#L98
[d174]: https://github.com/40ants/humanize-duration/blob/9a950cd6289035de6cc72bfe81789a4001e1e1a8/src/core.lisp#L116
[923d]: https://github.com/40ants/humanize-duration/blob/9a950cd6289035de6cc72bfe81789a4001e1e1a8/src/core.lisp#L95
[e926]: https://github.com/40ants/humanize-duration/blob/9a950cd6289035de6cc72bfe81789a4001e1e1a8/src/ru.lisp#L98
[2c00]: https://quickdocs.org/40ants-doc
[ce67]: https://quickdocs.org/docs-config
[6422]: https://quickdocs.org/local-time-duration
[9201]: https://quickdocs.org/with-output-to-stream

* * *
###### [generated by [40ANTS-DOC](https://40ants.com/doc/)]

0 comments on commit 3d95b5c

Please sign in to comment.