Skip to content

Commit daca8c6

Browse files
carsonipaeneasr
authored andcommitted
Fix Run and RunWithOptions docstring (#174)
1 parent 2b0896a commit daca8c6

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

dockertest.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -224,8 +224,8 @@ func (d *Pool) BuildAndRun(name, dockerfilePath string, env []string) (*Resource
224224
// RunWithOptions starts a docker container.
225225
// Optional modifier functions can be passed in order to change the hostconfig values not covered in RunOptions
226226
//
227-
// pool.Run(&RunOptions{Repository: "mongo", Cmd: []string{"mongod", "--smallfiles"}})
228-
// pool.Run(&RunOptions{Repository: "mongo", Cmd: []string{"mongod", "--smallfiles"}}, func(hostConfig *dc.HostConfig) {
227+
// pool.RunWithOptions(&RunOptions{Repository: "mongo", Cmd: []string{"mongod", "--smallfiles"}})
228+
// pool.RunWithOptions(&RunOptions{Repository: "mongo", Cmd: []string{"mongod", "--smallfiles"}}, func(hostConfig *dc.HostConfig) {
229229
// hostConfig.ShmSize = shmemsize
230230
// })
231231
func (d *Pool) RunWithOptions(opts *RunOptions, hcOpts ...func(*dc.HostConfig)) (*Resource, error) {
@@ -334,7 +334,7 @@ func (d *Pool) RunWithOptions(opts *RunOptions, hcOpts ...func(*dc.HostConfig))
334334

335335
// Run starts a docker container.
336336
//
337-
// pool.Run("mysql", "5.3", []string{"FOO=BAR", "BAR=BAZ"})
337+
// pool.Run("mysql", "5.3", []string{"FOO=BAR", "BAR=BAZ"})
338338
func (d *Pool) Run(repository, tag string, env []string) (*Resource, error) {
339339
return d.RunWithOptions(&RunOptions{Repository: repository, Tag: tag, Env: env})
340340
}

0 commit comments

Comments
 (0)