Skip to content

Commit

Permalink
Wording fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
Makaze committed Apr 17, 2024
1 parent e8ca3f9 commit f7360f8
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,7 @@ watch.stop() -- Stop all watchers

```lua
local watch = require("watch")
-- Use `%s` inside the command to insert the absolute path of the current file.
watch.start("cat %s", 3000, nil, "errog.log") -- Specify 3000 ms refresh
watch.start("cat %s", nil, nil, "errog.log") -- Default to 1000 ms refresh
```
Expand Down
2 changes: 1 addition & 1 deletion doc/watch.txt
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ watch.start({command}, {refresh_rate*}, {bufnr*}, {file*}) *watch.start()*
milliseconds. Defaults to `500`.
{bufnr} (integer) (optional) The buffer number to load to.
Defaults to a new buffer.
{file} (string) (optional) The absolute path of a file to
{file} (string) (optional) The path of a file to
watch. If given, the command will be run
when the file is modified on the disk,
checking at an interval of {refresh_rate}.
Expand Down

0 comments on commit f7360f8

Please sign in to comment.