Liking cljdoc? Tell your friends :D

orzo.sprint


calendar-sprint-numberclj

(calendar-sprint-number {:keys [sprint-size sprint-file-path]
                         :or {sprint-size 2}})

Returns a number based on the sprint of the project. Sprints usually emcompass several weeks.

It receives a map with the following keys:

  • :sprint-size: (default 2) how many weeks each sprint usually has
  • :sprint-file-path: a path to a configuration file that's used as foundation for the calculations

The file specified follows the convention where each line is <SPRINT_NUM> <YYYY-MM-DD> in a sequential manner where <SPRINT_NUM> represents the sprint number and YYYY-MM-DD represents the last day of the sprint.

At least one line is mandatory to set the first sprint.

Thanks to Andre Carvalho for the inspiration behind this idea.

Returns a number based on the sprint of the project. Sprints usually
emcompass several weeks.

It receives a map with the following keys:

- `:sprint-size`: (default 2) how many weeks each sprint usually has
- `:sprint-file-path`: a path to a configuration file that's used as
foundation for the calculations

The file specified follows the convention where each line is
`<SPRINT_NUM> <YYYY-MM-DD>` in a sequential manner where
`<SPRINT_NUM>` represents the sprint number and `YYYY-MM-DD`
represents the last day of the sprint.

At least one line is mandatory to set the first sprint.

Thanks to Andre Carvalho for the inspiration behind this idea.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close