jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #2709 from jochenvdv/osproc-doc

Browse source 
Fix osproc documentation
This commit is contained in:
reactormonk 2015-05-13 11:45:27 -05:00
commit 0bf78e2629
1 changed files with 12 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

24
lib/pure/osproc.nim
View file

@ -195,43 +195,43 @@ proc peekExitCode*(p: Process): int {.tags: [].}
proc inputStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].} proc inputStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].}
## returns ``p``'s input stream for writing to. ## returns ``p``'s input stream for writing to.
## ##
## **Warning**: The returned `PStream` should not be closed manually as it ## **Warning**: The returned `Stream` should not be closed manually as it
## is closed when closing the PProcess ``p``. ## is closed when closing the Process ``p``.
proc outputStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].} proc outputStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].}
## returns ``p``'s output stream for reading from. ## returns ``p``'s output stream for reading from.
## ##
## **Warning**: The returned `PStream` should not be closed manually as it ## **Warning**: The returned `Stream` should not be closed manually as it
## is closed when closing the PProcess ``p``. ## is closed when closing the Process ``p``.
proc errorStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].} proc errorStream*(p: Process): Stream {.rtl, extern: "nosp$1", tags: [].}
## returns ``p``'s error stream for reading from. ## returns ``p``'s error stream for reading from.
## ##
## **Warning**: The returned `PStream` should not be closed manually as it ## **Warning**: The returned `Stream` should not be closed manually as it
## is closed when closing the PProcess ``p``. ## is closed when closing the Process ``p``.
proc inputHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1", proc inputHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1",
tags: [].} = tags: [].} =
## returns ``p``'s input file handle for writing to. ## returns ``p``'s input file handle for writing to.
## ##
## **Warning**: The returned `TFileHandle` should not be closed manually as ## **Warning**: The returned `FileHandle` should not be closed manually as
## it is closed when closing the PProcess ``p``. ## it is closed when closing the Process ``p``.
result = p.inHandle result = p.inHandle
proc outputHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1", proc outputHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1",
tags: [].} = tags: [].} =
## returns ``p``'s output file handle for reading from. ## returns ``p``'s output file handle for reading from.
## ##
## **Warning**: The returned `TFileHandle` should not be closed manually as ## **Warning**: The returned `FileHandle` should not be closed manually as
## it is closed when closing the PProcess ``p``. ## it is closed when closing the Process ``p``.
result = p.outHandle result = p.outHandle
proc errorHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1", proc errorHandle*(p: Process): FileHandle {.rtl, extern: "nosp$1",
tags: [].} = tags: [].} =
## returns ``p``'s error file handle for reading from. ## returns ``p``'s error file handle for reading from.
## ##
## **Warning**: The returned `TFileHandle` should not be closed manually as ## **Warning**: The returned `FileHandle` should not be closed manually as
## it is closed when closing the PProcess ``p``. ## it is closed when closing the Process ``p``.
result = p.errHandle result = p.errHandle
proc countProcessors*(): int {.rtl, extern: "nosp$1".} = proc countProcessors*(): int {.rtl, extern: "nosp$1".} =