use single backtick (#17141)
This commit is contained in:
parent
4f10dde64a
commit
4556901572
11 changed files with 68 additions and 68 deletions
|
|
@ -7,7 +7,7 @@
|
|||
# distribution, for details about the copyright.
|
||||
#
|
||||
|
||||
# An ``include`` file for the different hash set implementations.
|
||||
# An `include` file for the different hash set implementations.
|
||||
|
||||
|
||||
template maxHash(t): untyped = high(t.data)
|
||||
|
|
|
|||
|
|
@ -60,13 +60,13 @@ template withLock(t, x: untyped) =
|
|||
|
||||
template withValue*[A, B](t: var SharedTable[A, B], key: A,
|
||||
value, body: untyped) =
|
||||
## retrieves the value at ``t[key]``.
|
||||
## `value` can be modified in the scope of the ``withValue`` call.
|
||||
## retrieves the value at `t[key]`.
|
||||
## `value` can be modified in the scope of the `withValue` call.
|
||||
##
|
||||
## .. code-block:: nim
|
||||
##
|
||||
## sharedTable.withValue(key, value) do:
|
||||
## # block is executed only if ``key`` in ``t``
|
||||
## # block is executed only if `key` in `t`
|
||||
## # value is threadsafe in block
|
||||
## value.name = "username"
|
||||
## value.uid = 1000
|
||||
|
|
@ -84,18 +84,18 @@ template withValue*[A, B](t: var SharedTable[A, B], key: A,
|
|||
|
||||
template withValue*[A, B](t: var SharedTable[A, B], key: A,
|
||||
value, body1, body2: untyped) =
|
||||
## retrieves the value at ``t[key]``.
|
||||
## `value` can be modified in the scope of the ``withValue`` call.
|
||||
## retrieves the value at `t[key]`.
|
||||
## `value` can be modified in the scope of the `withValue` call.
|
||||
##
|
||||
## .. code-block:: nim
|
||||
##
|
||||
## sharedTable.withValue(key, value) do:
|
||||
## # block is executed only if ``key`` in ``t``
|
||||
## # block is executed only if `key` in `t`
|
||||
## # value is threadsafe in block
|
||||
## value.name = "username"
|
||||
## value.uid = 1000
|
||||
## do:
|
||||
## # block is executed when ``key`` not in ``t``
|
||||
## # block is executed when `key` not in `t`
|
||||
## raise newException(KeyError, "Key not found")
|
||||
##
|
||||
acquire(t.lock)
|
||||
|
|
@ -112,8 +112,8 @@ template withValue*[A, B](t: var SharedTable[A, B], key: A,
|
|||
release(t.lock)
|
||||
|
||||
proc mget*[A, B](t: var SharedTable[A, B], key: A): var B =
|
||||
## retrieves the value at ``t[key]``. The value can be modified.
|
||||
## If `key` is not in `t`, the ``KeyError`` exception is raised.
|
||||
## retrieves the value at `t[key]`. The value can be modified.
|
||||
## If `key` is not in `t`, the `KeyError` exception is raised.
|
||||
withLock t:
|
||||
var hc: Hash
|
||||
var index = rawGet(t, key, hc)
|
||||
|
|
@ -126,10 +126,10 @@ proc mget*[A, B](t: var SharedTable[A, B], key: A): var B =
|
|||
raise newException(KeyError, "key not found")
|
||||
|
||||
proc mgetOrPut*[A, B](t: var SharedTable[A, B], key: A, val: B): var B =
|
||||
## retrieves value at ``t[key]`` or puts ``val`` if not present, either way
|
||||
## retrieves value at `t[key]` or puts `val` if not present, either way
|
||||
## returning a value which can be modified. **Note**: This is inherently
|
||||
## unsafe in the context of multi-threading since it returns a pointer
|
||||
## to ``B``.
|
||||
## to `B`.
|
||||
withLock t:
|
||||
mgetOrPutImpl(enlarge)
|
||||
|
||||
|
|
@ -144,24 +144,24 @@ template tabCellHash(i) = t.data[i].hcode
|
|||
|
||||
proc withKey*[A, B](t: var SharedTable[A, B], key: A,
|
||||
mapper: proc(key: A, val: var B, pairExists: var bool)) =
|
||||
## Computes a new mapping for the ``key`` with the specified ``mapper``
|
||||
## Computes a new mapping for the `key` with the specified `mapper`
|
||||
## procedure.
|
||||
##
|
||||
## The ``mapper`` takes 3 arguments:
|
||||
## The `mapper` takes 3 arguments:
|
||||
##
|
||||
## 1. ``key`` - the current key, if it exists, or the key passed to
|
||||
## ``withKey`` otherwise;
|
||||
## 2. ``val`` - the current value, if the key exists, or default value
|
||||
## 1. `key` - the current key, if it exists, or the key passed to
|
||||
## `withKey` otherwise;
|
||||
## 2. `val` - the current value, if the key exists, or default value
|
||||
## of the type otherwise;
|
||||
## 3. ``pairExists`` - ``true`` if the key exists, ``false`` otherwise.
|
||||
## 3. `pairExists` - `true` if the key exists, `false` otherwise.
|
||||
##
|
||||
## The ``mapper`` can can modify ``val`` and ``pairExists`` values to change
|
||||
## The `mapper` can can modify `val` and `pairExists` values to change
|
||||
## the mapping of the key or delete it from the table.
|
||||
## When adding a value, make sure to set ``pairExists`` to ``true`` along
|
||||
## with modifying the ``val``.
|
||||
## When adding a value, make sure to set `pairExists` to `true` along
|
||||
## with modifying the `val`.
|
||||
##
|
||||
## The operation is performed atomically and other operations on the table
|
||||
## will be blocked while the ``mapper`` is invoked, so it should be short and
|
||||
## will be blocked while the `mapper` is invoked, so it should be short and
|
||||
## simple.
|
||||
##
|
||||
## Example usage:
|
||||
|
|
@ -196,7 +196,7 @@ proc `[]=`*[A, B](t: var SharedTable[A, B], key: A, val: B) =
|
|||
putImpl(enlarge)
|
||||
|
||||
proc add*[A, B](t: var SharedTable[A, B], key: A, val: B) =
|
||||
## puts a new (key, value)-pair into `t` even if ``t[key]`` already exists.
|
||||
## puts a new (key, value)-pair into `t` even if `t[key]` already exists.
|
||||
## This can introduce duplicate keys into the table!
|
||||
withLock t:
|
||||
addImpl(enlarge)
|
||||
|
|
|
|||
|
|
@ -49,8 +49,8 @@ else:
|
|||
proc c_unsetenv(env: cstring): cint {.
|
||||
importc: "unsetenv", header: "<stdlib.h>".}
|
||||
|
||||
# Environment handling cannot be put into RTL, because the ``envPairs``
|
||||
# iterator depends on ``environment``.
|
||||
# Environment handling cannot be put into RTL, because the `envPairs`
|
||||
# iterator depends on `environment`.
|
||||
|
||||
var
|
||||
envComputed {.threadvar.}: bool
|
||||
|
|
|
|||
|
|
@ -20,10 +20,10 @@ proc osErrorMsg*(errorCode: OSErrorCode): string =
|
|||
##
|
||||
## The error code can be retrieved using the `osLastError proc <#osLastError>`_.
|
||||
##
|
||||
## If conversion fails, or ``errorCode`` is ``0`` then ``""`` will be
|
||||
## If conversion fails, or `errorCode` is `0` then `""` will be
|
||||
## returned.
|
||||
##
|
||||
## On Windows, the ``-d:useWinAnsi`` compilation flag can be used to
|
||||
## On Windows, the `-d:useWinAnsi` compilation flag can be used to
|
||||
## make this procedure use the non-unicode Win API calls to retrieve the
|
||||
## message.
|
||||
##
|
||||
|
|
@ -62,15 +62,15 @@ proc newOSError*(
|
|||
): owned(ref OSError) {.noinline.} =
|
||||
## Creates a new `OSError exception <system.html#OSError>`_.
|
||||
##
|
||||
## The ``errorCode`` will determine the
|
||||
## The `errorCode` will determine the
|
||||
## message, `osErrorMsg proc <#osErrorMsg,OSErrorCode>`_ will be used
|
||||
## to get this message.
|
||||
##
|
||||
## The error code can be retrieved using the `osLastError proc
|
||||
## <#osLastError>`_.
|
||||
##
|
||||
## If the error code is ``0`` or an error message could not be retrieved,
|
||||
## the message ``unknown OS error`` will be used.
|
||||
## If the error code is `0` or an error message could not be retrieved,
|
||||
## the message `unknown OS error` will be used.
|
||||
##
|
||||
## See also:
|
||||
## * `osErrorMsg proc <#osErrorMsg,OSErrorCode>`_
|
||||
|
|
@ -99,13 +99,13 @@ proc osLastError*(): OSErrorCode {.sideEffect.} =
|
|||
##
|
||||
## This procedure is useful in the event when an OS call fails. In that case
|
||||
## this procedure will return the error code describing the reason why the
|
||||
## OS call failed. The ``OSErrorMsg`` procedure can then be used to convert
|
||||
## OS call failed. The `OSErrorMsg` procedure can then be used to convert
|
||||
## this code into a string.
|
||||
##
|
||||
## **Warning**:
|
||||
## The behaviour of this procedure varies between Windows and POSIX systems.
|
||||
## On Windows some OS calls can reset the error code to ``0`` causing this
|
||||
## procedure to return ``0``. It is therefore advised to call this procedure
|
||||
## On Windows some OS calls can reset the error code to `0` causing this
|
||||
## procedure to return `0`. It is therefore advised to call this procedure
|
||||
## immediately after an OS call fails. On POSIX systems this is not a problem.
|
||||
##
|
||||
## See also:
|
||||
|
|
|
|||
|
|
@ -1,5 +1,5 @@
|
|||
# Include file that implements 'DirSep' and friends. Do not import this when
|
||||
# you also import ``os.nim``!
|
||||
# you also import `os.nim`!
|
||||
|
||||
# Improved based on info in 'compiler/platform.nim'
|
||||
|
||||
|
|
@ -88,7 +88,7 @@ const
|
|||
|
||||
ExtSep* = '.'
|
||||
## The character which separates the base filename from the extension;
|
||||
## for example, the `'.'` in ``os.nim``.
|
||||
## for example, the `'.'` in `os.nim`.
|
||||
|
||||
# MacOS paths
|
||||
# ===========
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue