Fix spellings (#12277) [backport]

This commit is contained in:
Federico Ceratto 2019-09-27 06:02:54 +01:00 • committed by Andreas Rumpf
commit 39290cf88c
110 changed files with 166 additions and 166 deletions

View file

@ -198,7 +198,7 @@ proc processTimers(
dec count
didSomeWork = true
# Return the number of miliseconds in which the next timer will expire.
# Return the number of milliseconds in which the next timer will expire.
if p.timers.len == 0: return
let millisecs = (p.timers[0].finishAt - getMonoTime()).inMilliseconds

View file

@ -74,7 +74,7 @@ proc write*[T](future: FutureStream[T], value: T): Future[void] =
result.fail(newException(ValueError, msg))
return
# TODO: Implement limiting of the streams storage to prevent it growing
# infinitely when no reads are occuring.
# infinitely when no reads are occurring.
future.queue.addLast(value)
if not future.cb.isNil: future.cb()
result.complete()

View file

@ -23,7 +23,7 @@
## to force predictable behaviour for all input, causing a small performance hit.
##
## At this time only `fastLog2`, `firstSetBit, `countLeadingZeroBits`, `countTrailingZeroBits`
## may return undefined and/or platform dependant value if given invalid input.
## may return undefined and/or platform dependent value if given invalid input.
proc bitnot*[T: SomeInteger](x: T): T {.magic: "BitnotI", noSideEffect.}
## Computes the `bitwise complement` of the integer `x`.

View file

@ -848,7 +848,7 @@ template mapIt*(s: typed, op: untyped): untyped =
result
template mapIt*(s, typ, op: untyped): untyped {.error:
"Deprecated since v0.12; Use 'mapIt(seq1, op)' - without specifying the type of the returned seqence".} =
"Deprecated since v0.12; Use 'mapIt(seq1, op)' - without specifying the type of the returned sequence".} =
var result: seq[typ] = @[]
for it {.inject.} in items(s):
result.add(op)
@ -883,7 +883,7 @@ template newSeqWith*(len: int, init: untyped): untyped =
## or to populate fields of the created sequence.
##
runnableExamples:
## Creates a seqence containing 5 bool sequences, each of length of 3.
## Creates a sequence containing 5 bool sequences, each of length of 3.
var seq2D = newSeqWith(5, newSeq[bool](3))
assert seq2D.len == 5
assert seq2D[0].len == 3

View file

@ -47,7 +47,7 @@ when defined(cpp) or defined(nimdoc):
## Behaves like Acquire when applied to load, like Release when
## applied to a store and like AcquireRelease when applied to a
## read-modify-write operation.
## Also garantees that all threads observe the same total ordering
## Also guarantees that all threads observe the same total ordering
## with other moSequentiallyConsistent operations.
type

View file

@ -50,7 +50,7 @@ when defined(haiku):
header: "<OS.h>".}
proc countProcessors*(): int {.rtl, extern: "ncpi$1".} =
## returns the numer of the processors/cores the machine has.
## returns the number of the processors/cores the machine has.
## Returns 0 if it cannot be detected.
when defined(windows):
type

View file

@ -2025,7 +2025,7 @@ proc parseHtml*(s: Stream, filename: string,
#if x.kind != xmlEof:
# adderr(errorMsg(x, "EOF expected"))
while x.kind != xmlEof:
var oldPos = x.bufpos # little hack to see if we made any progess
var oldPos = x.bufpos # little hack to see if we made any progress
result.addNode(parse(x, errors))
if x.bufpos == oldPos:
# force progress!

View file

@ -30,7 +30,7 @@
## ``JNull``. You check the kind of this object variant by using the ``kind``
## accessor.
##
## For a ``JsonNode`` who's kind is ``JObject``, you can acess its fields using
## For a ``JsonNode`` who's kind is ``JObject``, you can access its fields using
## the ``[]`` operator. The following example shows how to do this:
##
## .. code-block:: Nim

View file

@ -12,7 +12,7 @@
## which work for mixed float/int operands.
## All operations convert the integer operand into the
## type of the float operand. For numerical expressions, the return
## type is always the type of the float involved in the expresssion,
## type is always the type of the float involved in the expression,
## i.e., there is no auto conversion from float32 to float64.
##
## Note: In general, auto-converting from int to float loses

View file

@ -303,7 +303,7 @@ when defined(posix) or defined(nimdoc):
## resize and re-map the file underlying an ``allowRemap MemFile``.
## **Note**: this assumes the entire file is mapped read-write at offset zero.
## Also, the value of ``.mem`` will probably change.
## **Note**: This is not (yet) avaiable on Windows.
## **Note**: This is not (yet) available on Windows.
when defined(posix):
if f.handle == -1:
raise newException(IOError,

View file

@ -230,7 +230,7 @@ proc newSocket*(domain: Domain = AF_INET, sockType: SockType = SOCK_STREAM,
result = newSocket(fd, domain, sockType, protocol, buffered)
proc parseIPv4Address(addressStr: string): IpAddress =
## Parses IPv4 adresses
## Parses IPv4 addresses
## Raises ValueError on errors
var
byteCount = 0
@ -264,7 +264,7 @@ proc parseIPv4Address(addressStr: string): IpAddress =
result.address_v4[byteCount] = cast[uint8](currentByte)
proc parseIPv6Address(addressStr: string): IpAddress =
## Parses IPv6 adresses
## Parses IPv6 addresses
## Raises ValueError on errors
result = IpAddress(family: IpAddressFamily.IPv6)
if addressStr.len < 2:
@ -1657,7 +1657,7 @@ proc connect*(socket: Socket, address: string, port = Port(0),
timeout: int) {.tags: [ReadIOEffect, WriteIOEffect].} =
## Connects to server as specified by ``address`` on port specified by ``port``.
##
## The ``timeout`` paremeter specifies the time in milliseconds to allow for
## The ``timeout`` parameter specifies the time in milliseconds to allow for
## the connection to the server to be made.
socket.fd.setBlocking(false)

View file

@ -382,7 +382,7 @@ iterator parentDirs*(path: string, fromRoot=false, inclusive=true): string =
## Walks over all parent directories of a given `path`.
##
## If `fromRoot` is true (default: false), the traversal will start from
## the file system root diretory.
## the file system root directory.
## If `inclusive` is true (default), the original argument will be included
## in the traversal.
##
@ -781,7 +781,7 @@ proc getTempDir*(): string {.rtl, extern: "nos$1",
## **Please do not use this**: On Android, it currently
## returns ``getHomeDir()``, and on other Unix based systems it can cause
## security problems too. That said, you can override this implementation
## by adding ``-d:tempDir=mytempname`` to your compiler invokation.
## by adding ``-d:tempDir=mytempname`` to your compiler invocation.
##
## See also:
## * `getHomeDir proc <#getHomeDir>`_
@ -1868,7 +1868,7 @@ type
proc getCurrentCompilerExe*(): string {.compileTime.} = discard
## This is `getAppFilename() <#getAppFilename>`_ at compile time.
##
## Can be used to retrive the currently executing
## Can be used to retrieve the currently executing
## Nim compiler from a Nim or nimscript program, or the nimble binary
## inside a nimble program (likewise with other binaries built from
## compiler API).
@ -2475,7 +2475,7 @@ when defined(nimdoc):
##
## Unlike `argc`:idx: in C, if your binary was called without parameters this
## will return zero.
## You can query each individual paramater with `paramStr proc <#paramStr,int>`_
## You can query each individual parameter with `paramStr proc <#paramStr,int>`_
## or retrieve all of them in one go with `commandLineParams proc
## <#commandLineParams>`_.
##

View file

@ -318,7 +318,7 @@ proc readHeaderRow*(my: var CsvParser) =
my.headers = my.row
proc rowEntry*(my: var CsvParser, entry: string): var string =
## Acceses a specified `entry` from the current row.
## Accesses a specified `entry` from the current row.
##
## Assumes that `readHeaderRow <#readHeaderRow,CsvParser>`_ has already been
## called.

View file

@ -711,7 +711,7 @@ proc identOrLiteral(p: var SqlParser): SqlNode =
getTok(p)
else:
sqlError(p, "expression expected")
getTok(p) # we must consume a token here to prevend endless loops!
getTok(p) # we must consume a token here to prevent endless loops!
proc primary(p: var SqlParser): SqlNode =
if (p.tok.kind == tkOperator and (p.tok.literal == "+" or p.tok.literal == "-")) or isKeyw(p, "not"):

View file

@ -634,7 +634,7 @@ iterator interpolatedFragments*(s: string): tuple[kind: InterpolatedKind,
kind = ikDollar
else:
raise newException(ValueError,
"Unable to parse a varible name at " & substr(s, i, s.high))
"Unable to parse a variable name at " & substr(s, i, s.high))
else:
while j < s.len and s[j] != '$': inc j
kind = ikStr

View file

@ -154,7 +154,7 @@ import
# xmlElementCloseEnd, ## ``/>``
type
XmlEventKind* = enum ## enumation of all events that may occur when parsing
XmlEventKind* = enum ## enumeration of all events that may occur when parsing
xmlError, ## an error occurred during parsing
xmlEof, ## end of file reached
xmlCharData, ## character data

View file

@ -186,7 +186,7 @@ when defined(nimdoc):
proc setData*[T](s: Selector[T], fd: SocketHandle|int, data: var T): bool =
## Associate application-defined ``data`` with descriptor ``fd``.
##
## Returns ``true``, if data was succesfully updated, ``false`` otherwise.
## Returns ``true``, if data was successfully updated, ``false`` otherwise.
template isEmpty*[T](s: Selector[T]): bool = # TODO: Why is this a template?
## Returns ``true``, if there are no registered events or descriptors
@ -316,7 +316,7 @@ else:
proc verifySelectParams(timeout: int) =
# Timeout of -1 means: wait forever
# Anything higher is the time to wait in miliseconds.
# Anything higher is the time to wait in milliseconds.
doAssert(timeout >= -1, "Cannot select with a negative value, got " & $timeout)
when defined(linux):

View file

@ -206,7 +206,7 @@ proc auth*(smtp: Smtp | AsyncSmtp, username, password: string) {.multisync.} =
await smtp.checkReply("334") # TODO: Same as above, only "Password:" (I think?)
await smtp.debugSend(encode(password) & "\c\L")
await smtp.checkReply("235") # Check whether the authentification was successful.
await smtp.checkReply("235") # Check whether the authentication was successful.
proc sendMail*(smtp: Smtp | AsyncSmtp, fromAddr: string,
toAddrs: seq[string], msg: string) {.multisync.} =

View file

@ -299,7 +299,7 @@ type
alternateForm*: bool ## Whether to prefix binary, octal and hex numbers
## with ``0b``, ``0o``, ``0x``.
padWithZero*: bool ## Whether to pad with zeros rather than spaces.
minimumWidth*, precision*: int ## Desired minium width and precision.
minimumWidth*, precision*: int ## Desired minimum width and precision.
typ*: char ## Type like 'f', 'g' or 'd'.
endPosition*: int ## End position in the format specifier after
## ``parseStandardFormatSpecifier`` returned.
@ -617,7 +617,7 @@ when isMainModule:
check &"{1f:.3f}", "1.000"
check &"Hello, {s}!", "Hello, string!"
# Tests for identifers without parenthesis
# Tests for identifiers without parenthesis
check &"{s} works{s}", "string worksstring"
check &"{s:>7}", " string"
doAssert(not compiles(&"{s_works}")) # parsed as identifier `s_works`

View file

@ -326,7 +326,7 @@ proc del*(t: StringTableRef, key: string) =
## Removes `key` from `t`.
##
## See also:
## * `clear proc <#clear,StringTableRef,StringTableMode>`_ for reseting a
## * `clear proc <#clear,StringTableRef,StringTableMode>`_ for resetting a
## table to be empty
## * `[]= proc <#[]=,StringTableRef,string,string>`_ for inserting a new
## (key, value) pair in the table

View file

@ -2017,7 +2017,7 @@ proc countLines*(s: string): int {.noSideEffect,
## `character literal <manual.html#lexical-analysis-character-literals>`_
## newline combination (CR, LF, CR-LF) is supported.
##
## In this context, a line is any string seperated by a newline combination.
## In this context, a line is any string separated by a newline combination.
## A line can be an empty string.
##
## See also:
@ -2145,7 +2145,7 @@ proc multiReplace*(s: string, replacements: varargs[(string, string)]): string {
## pass through the input string.
##
## `multiReplace` performs all replacements in a single pass, this means it
## can be used to swap the occurences of "a" and "b", for instance.
## can be used to swap the occurrences of "a" and "b", for instance.
##
## If the resulting string is not longer than the original input string,
## only a single memory allocation is required.
@ -2280,14 +2280,14 @@ proc validIdentifier*(s: string): bool {.noSideEffect,
return true
# floating point formating:
# floating point formatting:
when not defined(js):
proc c_sprintf(buf, frmt: cstring): cint {.header: "<stdio.h>",
importc: "sprintf", varargs, noSideEffect.}
type
FloatFormatMode* = enum
## the different modes of floating point formating
## the different modes of floating point formatting
ffDefault, ## use the shorter floating point notation
ffDecimal, ## use decimal floating point notation
ffScientific ## use scientific notation (using ``e`` character)
@ -2892,7 +2892,7 @@ proc editDistance*(a, b: string): int {.noSideEffect,
inc(len1)
inc(len2)
var half = len1 shr 1
# initalize first row:
# initialize first row:
#var row = cast[ptr array[0..high(int) div 8, int]](alloc(len2*sizeof(int)))
var row: seq[int]
newSeq(row, len2)

View file

@ -133,7 +133,7 @@
The ``times`` module exports two similar types that are both used to
represent some amount of time: `Duration <#Duration>`_ and
`TimeInterval <#TimeInterval>`_.
This section explains how they differ and when one should be prefered over the
This section explains how they differ and when one should be preferred over the
other (short answer: use ``Duration`` unless support for months and years is
needed).
@ -152,7 +152,7 @@
A ``TimeInterval`` represents an amount of time expressed in calendar
units, for example "1 year and 2 days". Since some units cannot be
normalized (the length of a year is different for leap years for example),
the ``TimeInterval`` type uses seperate fields for every unit. The
the ``TimeInterval`` type uses separate fields for every unit. The
``TimeInterval``'s returned from this module generally don't normalize
**anything**, so even units that could be normalized (like seconds,
milliseconds and so on) are left untouched.
@ -393,7 +393,7 @@ type
years*: int ## The number of years
Timezone* = ref object ## \
## Timezone interface for supporting `DateTime <#DateTime>`_\s of arbritary
## Timezone interface for supporting `DateTime <#DateTime>`_\s of arbitrary
## timezones. The ``times`` module only supplies implementations for the
## systems local time and UTC.
zonedTimeFromTimeImpl: proc (x: Time): ZonedTime
@ -2526,7 +2526,7 @@ when not defined(JS):
## because sub-second resolution is likely to be supported (depending
## on the hardware/OS).
##
## ``getTime`` should generally be prefered over this proc.
## ``getTime`` should generally be preferred over this proc.
when defined(macosx):
var a: Timeval
gettimeofday(a)

View file

@ -134,7 +134,7 @@ type
## non-js target to true or false respectively.
## The deprecated environment variable
## ``NIMTEST_NO_COLOR``, when set,
## changes the defualt to true, if
## changes the default to true, if
## ``NIMTEST_COLOR`` is undefined.
outputLevel: OutputLevel
## Set the verbosity of test results.