Clarifies system.lines() docstring.

Amends c087f905134b249cf20cbabc4066fbfa62dd668a.
This commit is contained in:
Grzegorz Adam Hankiewicz
2014-01-14 10:38:03 +01:00
parent 63ab238f5d
commit 2c2174f2d0

View File

@@ -2238,8 +2238,8 @@ when not defined(JS): #and not defined(NimrodVM):
iterator lines*(filename: string): TaintedString {.tags: [FReadIO].} =
## Iterates over any line in the file named `filename`.
##
## If the file does not exist `EIO` is raised. The iterated lines will be
## stripped off the trailing newline character(s). Example:
## If the file does not exist `EIO` is raised. The trailing newline
## character(s) are removed from the iterated lines. Example:
##
## .. code-block:: nimrod
## import strutils
@@ -2257,8 +2257,8 @@ when not defined(JS): #and not defined(NimrodVM):
iterator lines*(f: TFile): TaintedString {.tags: [FReadIO].} =
## Iterate over any line in the file `f`.
##
## The iterated lines will be stripped off the trailing newline
## character(s). Example:
## The trailing newline character(s) are removed from the iterated lines.
## Example:
##
## .. code-block:: nimrod
## proc countZeros(filename: TFile): tuple[lines, zeros: int] =