Skip to content

Commit

Permalink
System.Job: Fix documents
Browse files Browse the repository at this point in the history
  • Loading branch information
lambdalisue committed Jul 1, 2017
1 parent dcf3b7d commit d5116ca
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 10 deletions.
18 changes: 9 additions & 9 deletions doc/vital/System/Job.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ INSTANCE |Vital.System.Job-instance|
=============================================================================
INTRODUCTION *Vital.System.Job-introduction*

*Vital.System.Job* is a wrapper module of job feature which has introduced
from Vim 8 or Neovim.
*Vital.System.Job* is a wrapper module of the |job| feature to provide an
abstract layer that works both for Vim 8 and Neovim at the same time.

=============================================================================
USAGE *Vital.System.Job-usage*

The following code start "git status" and store its' stdout/stderr output in
the instance attribute.
The following code starts "git status" and stores its stdout/stderr output
in the instance attribute.
>
function! s:on_stdout(job, msg, event) abort dict
let leading = get(self.stdout, -1, '')
Expand Down Expand Up @@ -67,13 +67,13 @@ start({args}[, {options}])
The following attributes are allowed in {options}.

"on_stdout" A callback called when the process output to stdout.
The {msg} is a stdout data |List|, and
The {msg} is a stdout data |List|.
"on_stderr" A callback called when the process output to stderr.
The {msg} is a stderr data |List|.
"on_exit" A callback called when the process terminated.
The {msg} is an exit status.

Note that all attributes in the {options} is exposed to the job
Note that all attributes in the {options} are exposed to the job
instance and users can access that in callbacks by |self| while the
callbacks above are called as a dictionary function of the job
instance.
Expand All @@ -86,7 +86,7 @@ INSTANCE *Vital.System.Job-instance*

*Vital.System.Job-instance.id()*
id()
Return an unique number of the process.
Return a unique number of the process.

*Vital.System.Job-instance.status()*
status()
Expand Down Expand Up @@ -123,8 +123,8 @@ wait([{timeout}])
The unit of {timeout} is milliseconds.
When user hit <C-c>, the process will terminate.

Warning: Vim 8.0.0026 and earlier is not supported and will throws
an exception when this method has called.
Warning: Vim 8.0.0026 or earlier is not supported and will throws
an exception when this method has been called.


=============================================================================
Expand Down
2 changes: 1 addition & 1 deletion test/System/Process/System.vimspec
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Describe System.Process.System
\ Process.execute([], options)
End

It DOES NOT throws an exception when {options.background} is specified
It DOES NOT throw an exception when {options.background} is specified
let options.background = 1
let args = ['false']
let result = Process.execute(args, options)
Expand Down

0 comments on commit d5116ca

Please sign in to comment.