Skip to content

Commit fe994c1

Browse files
committedApr 7, 2017
docs
1 parent 56c021f commit fe994c1

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed
 

‎README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ These extras are `[at]`, `[every]`, `[in]` and are called like `[every 5000 MyPr
5353
| -glob | Boolean | Adds the -all and -glob flags to the flags. Mostly useful for -cancel where ids use glob pattern while cancelling. |
5454
| -flag | String | Adds the given flag to the list of flags to send to the request. |
5555
| -flags | List | Adds the list of flags to the flags to send to the request. |
56-
| -subst | Boolean | Should we run `[subst -nocommands]` before calling the -command and -while? (Default 0) |
56+
| -subst | Boolean | Should we run `[subst -nocommands]` before calling the `-command` and `-while` requests. (Default 0) |
5757
| -cancel | Task ID | Cancels one or more tasks by their ID. |
5858
| -info | String | Requests specific information as a response to the command. |
5959

@@ -80,8 +80,6 @@ task -every {10 seconds} -for {50 seconds} -command myproc
8080
Flags can be provided during a request. These allow modification to how the request will handle itself. At
8181
this time they are used during a `-cancel` request to modify how we search for the matching id's to cancel.
8282

83-
For example:
84-
8583
```tcl
8684
task -id foo_bar -in {5 seconds} -command myproc
8785
task -id foo_bax -in 5000 -command myproc
@@ -97,6 +95,9 @@ task -glob -cancel foo*
9795
task -flags [list -all -not -glob] -cancel foo*
9896
```
9997

98+
> **Tip:** By default the lsearch command that looks for the id's that we want to cancel has the `-exact` flag added to it.
99+
> Adding flags allows you to override that in this case.
100+
100101
## Command Examples
101102

102103
> **Note:** In all examples we will need to be setup to receive from the tcl event loop.

0 commit comments

Comments
 (0)