diff options
Diffstat (limited to 'lib/pure/base64.nim')
| -rw-r--r-- | lib/pure/base64.nim | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/lib/pure/base64.nim b/lib/pure/base64.nim index 2abdc805d..a590ac002 100644 --- a/lib/pure/base64.nim +++ b/lib/pure/base64.nim @@ -149,9 +149,9 @@ proc encode*[T: SomeInteger|char](s: openArray[T], safe = false): string = ## This procedure encodes an openarray (array or sequence) of either integers ## or characters. ## - ## If ``safe`` is ``true`` then it will encode using the + ## If `safe` is `true` then it will encode using the ## URL-Safe and Filesystem-safe standard alphabet characters, - ## which substitutes ``-`` instead of ``+`` and ``_`` instead of ``/``. + ## which substitutes `-` instead of `+` and `_` instead of `/`. ## * https://en.wikipedia.org/wiki/Base64#URL_applications ## * https://tools.ietf.org/html/rfc4648#page-7 ## @@ -165,13 +165,13 @@ proc encode*[T: SomeInteger|char](s: openArray[T], safe = false): string = encodeImpl() proc encode*(s: string, safe = false): string = - ## Encodes ``s`` into base64 representation. + ## Encodes `s` into base64 representation. ## ## This procedure encodes a string. ## - ## If ``safe`` is ``true`` then it will encode using the + ## If `safe` is `true` then it will encode using the ## URL-Safe and Filesystem-safe standard alphabet characters, - ## which substitutes ``-`` instead of ``+`` and ``_`` instead of ``/``. + ## which substitutes `-` instead of `+` and `_` instead of `/`. ## * https://en.wikipedia.org/wiki/Base64#URL_applications ## * https://tools.ietf.org/html/rfc4648#page-7 ## @@ -183,8 +183,8 @@ proc encode*(s: string, safe = false): string = encodeImpl() proc encodeMime*(s: string, lineLen = 75, newLine = "\r\n"): string = - ## Encodes ``s`` into base64 representation as lines. - ## Used in email MIME format, use ``lineLen`` and ``newline``. + ## Encodes `s` into base64 representation as lines. + ## Used in email MIME format, use `lineLen` and `newline`. ## ## This procedure encodes a string according to MIME spec. ## @@ -215,7 +215,7 @@ const decodeTable = initDecodeTable() proc decode*(s: string): string = - ## Decodes string ``s`` in base64 representation back into its original form. + ## Decodes string `s` in base64 representation back into its original form. ## The initial whitespace is skipped. ## ## **See also:** |