chore(docs): auto generate docs

epwalsh · Nov 30, 2023 · 16e573f · 16e573f
1 parent 7ff55b0
commit 16e573f
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/doc/pomo.txt b/doc/pomo.txt
@@ -22,8 +22,16 @@ Lua.
 
 COMMANDS                                                       *pomo-commands*
 
-- `:TimerStart TIMELIMIT [NAME]` to start a new timer. For example, `:TimerStart 25m Work` to start a timer for 25 minutes called "Work". Currently the time limit can only be specified in hours, minutes, or seconds, such as `10m` for "10 minutes" or `10s` for "10 seconds".
-- `:TimerStop [TIMERID]` to stop a running timer, e.g. `:TimerStop 1`. If no ID is given, the latest timer is stopped.
+- `:TimerStart TIMELIMIT [NAME]` to start a new timer.
+    The time limit can be specified in hours, minutes, seconds, or a combination of
+    those, and _shouldn’t include any spaces_. For example:
+    - `:TimerStart 25m Work` to start a timer for 25 minutes called "Work".
+    - `:TimerStart 10s` to start a timer for 10 seconds.
+    - `:TimerStart 1h30m` to start a timer for an hour and a half.
+    pomo.nvim will recognize multiple forms of the time units, such as "m", "min",
+    "minute", or "minutes" for minutes.
+- `:TimerStop [TIMERID]` to stop a running timer, e.g. `:TimerStop 1`. If no ID
+    is given, the latest timer is stopped.
 
 
 ==============================================================================