Skip to content

Commit

Permalink
Document that timeoutadd accepts negative values
Browse files Browse the repository at this point in the history
Both timeoutset and timeoutadd accept negative value for each part of their
time argument (hours, minutes, seconds). I think using this feature shouln't be
encouraged as it makes the time less intuitive, but I see no reason to add more
code to prevent it.

Still, documenting that timeoutadd can be used to reduce the timeout is
important, so mention that it accepts negative values. Creative users may
discover that 1:-10 is 50 seconds by themselves.

See #1272.
  • Loading branch information
lmoureaux authored and psampathkumar committed Aug 15, 2022
1 parent e9de7ec commit 4659b57
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion server/commands.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -447,7 +447,7 @@ static struct command commands[] = {
"more time to finish their actions.\n"
"The time is specified as hours, minutes, and seconds using the "
"format hh:mm:ss (minutest and hours and are "
"optional)."),
"optional). Negative values are allowed."),
nullptr, CMD_ECHO_ALL, VCF_NONE, 50},
{"timeoutincrease", ALLOW_CTRL,
// TRANS: translate text between <> only
Expand Down

0 comments on commit 4659b57

Please sign in to comment.