convert code-blocks to runnableExamples in io (#18315)

Co-authored-by: konsumlamm <44230978+konsumlamm@users.noreply.github.com>
This commit is contained in:
xioren 2021-06-21 18:56:16 -07:00 • committed by GitHub
commit 9d3a813fb9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -912,14 +912,14 @@ iterator lines*(filename: string): string {.tags: [ReadIOEffect].} =
## If the file does not exist `IOError` is raised. The trailing newline ## If the file does not exist `IOError` is raised. The trailing newline
## character(s) are removed from the iterated lines. Example: ## character(s) are removed from the iterated lines. Example:
## ##
## .. code-block:: nim runnableExamples:
## import std/strutils import std/strutils
##
## proc transformLetters(filename: string) = proc transformLetters(filename: string) =
## var buffer = "" var buffer = ""
## for line in filename.lines: for line in filename.lines:
## buffer.add(line.replace("a", "0") & '\n') buffer.add(line.replace("a", "0") & '\n')
## writeFile(filename, buffer) writeFile(filename, buffer)
var f = open(filename, bufSize=8000) var f = open(filename, bufSize=8000)
try: try:
var res = newStringOfCap(80) var res = newStringOfCap(80)
@ -931,14 +931,13 @@ iterator lines*(f: File): string {.tags: [ReadIOEffect].} =
## Iterate over any line in the file `f`. ## Iterate over any line in the file `f`.
## ##
## The trailing newline character(s) are removed from the iterated lines. ## The trailing newline character(s) are removed from the iterated lines.
## Example:
## ##
## .. code-block:: nim runnableExamples:
## proc countZeros(filename: File): tuple[lines, zeros: int] = proc countZeros(filename: File): tuple[lines, zeros: int] =
## for line in filename.lines: for line in filename.lines:
## for letter in line: for letter in line:
## if letter == '0': if letter == '0':
## result.zeros += 1 result.zeros += 1
## result.lines += 1 result.lines += 1
var res = newStringOfCap(80) var res = newStringOfCap(80)
while f.readLine(res): yield res while f.readLine(res): yield res