-
Notifications
You must be signed in to change notification settings - Fork 3
/
docstrings.lisp
23 lines (18 loc) · 1.49 KB
/
docstrings.lisp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
(in-package #:cl-progress-bar)
(docs:define-docs
:formatter docs.ext:rich-aggregating-formatter
(variable *progress-bar*
(:description "Current progress bar or NIL if there is no progress bar active. Should not be manipulated manually."))
(variable *progress-bar-enabled*
(:description "Boolean. T if progress bar should be outputed."))
(function with-progress-bar
(:description "Macro. Build active progress bar. Requires size and description that will be printed out to the REPL. If *progress-bar-endabled* is nil or there is another progress bar active already progress bar will not be shown."
:arguments-and-values ((steps-count "Total number of steps that are expected before finish is reached.")
(description "FORMAT formula that should be printed when starting process.")
(desc-args "Arguments to FORMAT, should be compatible with description formula."))
:notes "Because with-progress-bar handles cases where another progress-bar is active it is generally safe to nest code with this macro on call stack. However, top level with-progress-bar should contain correct steps-count."))
(function update
(:description "Notify progress bar about step completion."
:arguments-and-values ((unit-count "How many steps has been finished?")
(progress-bar "Instance of progress-bar. Usually should be left with default (namely: *progress-bar*)."))
:thread-safety "This function is thread safe.")))