Try to get examples to render right as HTML.

This commit is contained in:
Charles Blake 2015-08-02 12:29:24 -04:00
commit 1bea224c4a

View file

@ -268,12 +268,14 @@ iterator memSlices*(mfile: MemFile, delim='\l', eat='\r'): MemSlice {.inline.} =
## This zero copy, memchr-limited method is probably the fastest way to ## This zero copy, memchr-limited method is probably the fastest way to
## iterate through lines in a file, however the returned (data,size) objects ## iterate through lines in a file, however the returned (data,size) objects
## are NOT Nim strings or even terminated C strings. So, be careful how data ## are NOT Nim strings or even terminated C strings. So, be careful how data
## is accessed (e.g., use C mem* functions, not str* functions). Example: ## is accessed (e.g., use C mem* functions, not str* functions). Example:
##
## .. code-block:: nim ## .. code-block:: nim
## var count = 0 ## var count = 0
## for slice in memSlices(memfiles.open("foo")): ## for slice in memSlices(memfiles.open("foo")):
## inc(count) ## inc(count)
## echo count ## echo count
proc c_memchr(cstr: pointer, c: char, n: csize): pointer {. proc c_memchr(cstr: pointer, c: char, n: csize): pointer {.
importc: "memchr", header: "<string.h>" .} importc: "memchr", header: "<string.h>" .}
proc `-!`(p, q: pointer): int {.inline.} = return cast[int](p) -% cast[int](q) proc `-!`(p, q: pointer): int {.inline.} = return cast[int](p) -% cast[int](q)
@ -308,9 +310,11 @@ iterator lines*(mfile: MemFile, delim='\l', eat='\r'): TaintedString {.inline.}
## Return each line in a file as a Nim string, like lines(File). ## Return each line in a file as a Nim string, like lines(File).
## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines. ## Default delimiting is [\\r]\\l which parse Unix or Windows text file lines.
## Pass eat='\0' to be strictly delim-delimited. Example: ## Pass eat='\0' to be strictly delim-delimited. Example:
##
## .. code-block:: nim ## .. code-block:: nim
## for line in lines(memfiles.open("foo")): ## for line in lines(memfiles.open("foo")):
## echo line ## echo line
var buf = TaintedString(newStringOfCap(80)) var buf = TaintedString(newStringOfCap(80))
for line in lines(mfile, buf, delim, eat): for line in lines(mfile, buf, delim, eat):
yield buf yield buf