Skip to content

Commit 668ed4f

Browse files
author
Mario Gutierrez
committed
fixed more typos
1 parent c6ed2c9 commit 668ed4f

File tree

1 file changed

+6
-8
lines changed

1 file changed

+6
-8
lines changed

README.md

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@ func Tasks(p *Project) {
2929

3030
p.Task("hello", func(c *Context) {
3131
name := c.Args.ZeroString("name", "n")
32-
3332
if name == "" {
3433
Bash("echo Hello $USER!")
3534
} else {
@@ -78,7 +77,7 @@ p.Task("build?", func() {})
7877
Task options
7978

8079
D{} or Dependencies{} - dependent tasks which run before task
81-
Debounce - minimum milliseconds before task can run again
80+
Debounce() - minimum milliseconds before task can run again
8281
W{} or Watches{} - array of glob file patterns to watch
8382

8483
/**/ - match zero or more directories
@@ -105,7 +104,7 @@ As an example,
105104

106105
```go
107106
p.Task("hello", func(c *Context) {
108-
# "(none)" is the default value
107+
// "(none)" is the default value
109108
name := c.Args.MayString("(none)", "name", "n")
110109
fmt.Println("Hello", name)
111110
})
@@ -124,24 +123,24 @@ godo hello -- -n dude
124123

125124
Args functions are categorized as
126125

127-
* `Must*` - Argument must be set by user
126+
* `Must*` - Argument must be set by user or panic.
128127

129128
```go
130129
c.Args.MustInt("number", "n")
131130
```
132131

133-
* `May*` - If argument is not set, default to first value in function call
132+
* `May*` - If argument is not set, default to first value.
134133

135134
```go
136135
// defaults to 100
137136
c.Args.MayInt(100, "number", "n")
138137
```
139138

140-
* `Zero*` - If argument is not set, default to zero value
139+
* `Zero*` - If argument is not set, default to zero value.
141140

142141
```go
143142
// defaults to 0
144-
c.Args.ZeroInt(100, "number", "n")
143+
c.Args.ZeroInt("number", "n")
145144
```
146145

147146
## Exec functions
@@ -243,4 +242,3 @@ The effective environment for exec functions is: `parent (if inherited) <- Env <
243242

244243
Paths should use `::` as a cross-platform path list separator. On Windows `::` is replaced with `;`.
245244
On Mac and linux `::` is replaced with `:`.
246-

0 commit comments

Comments
 (0)