mirrors/Nim
1
0
Fork 0
mirror of https://github.com/nim-lang/Nim.git synced 2026-02-12 14:23:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: say that nil can be used as a value (#13756)

Browse Source 
and improve wording in other ways

Showing that `nil` can be assigned helps to warn readers that variables can be `nil` even after being assigned a value.
This commit is contained in:
Rory O’Kane
2020-03-25 14:42:34 -04:00
committed by GitHub
parent 5b55aa52d0
commit 84b378b94f
1 changed files with 8 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
doc/manual.rst
View File

@@ -1767,12 +1767,15 @@ further information.
Nil
---
If a reference points to *nothing*, it has the value ``nil``. ``nil`` is also
the default value for all ``ref`` and ``ptr`` types. Dereferencing ``nil``
is an unrecoverable fatal runtime error (and not a panic).
A dereferencing operation ``p[]`` implies that ``p`` is not nil. This can be
exploited by the implementation to optimize code like:
If a reference points to *nothing*, it has the value ``nil``. ``nil`` is the
default value for all ``ref`` and ``ptr`` types. The ``nil`` value can also be
used like any other literal value. For example, it can be used in an assignment
like ``myRef = nil``.
Dereferencing ``nil`` is an unrecoverable fatal runtime error (and not a panic).
A successful dereferencing operation ``p[]`` implies that ``p`` is not nil. This
can be exploited by the implementation to optimize code like:
.. code-block:: nim