Fix some typos (#14843)
This commit is contained in:
parent
4f70180a58
commit
7936768560
12 changed files with 42 additions and 42 deletions
|
|
@ -78,7 +78,7 @@ Advanced options:
|
||||||
if path == @path, will use first matching dir in `--path`
|
if path == @path, will use first matching dir in `--path`
|
||||||
if path == @default (the default and most useful), will use
|
if path == @default (the default and most useful), will use
|
||||||
best match among @pkg,@path.
|
best match among @pkg,@path.
|
||||||
if these are nonexistant, will use project path
|
if these are nonexistent, will use project path
|
||||||
-b, --backend:c|cpp|js|objc sets backend to use with commands like `nim doc` or `nim r`
|
-b, --backend:c|cpp|js|objc sets backend to use with commands like `nim doc` or `nim r`
|
||||||
--docCmd:cmd if `cmd == skip`, skips runnableExamples
|
--docCmd:cmd if `cmd == skip`, skips runnableExamples
|
||||||
else, runs runnableExamples with given options, eg:
|
else, runs runnableExamples with given options, eg:
|
||||||
|
|
|
||||||
|
|
@ -13,31 +13,31 @@ library, araq is responsible for the compiler.
|
||||||
Compiler
|
Compiler
|
||||||
~~~~~~~~
|
~~~~~~~~
|
||||||
|
|
||||||
====================== ======================================================
|
=========================== ======================================================
|
||||||
subsystem owner(s)
|
subsystem owner(s)
|
||||||
====================== ======================================================
|
=========================== ======================================================
|
||||||
Parsing, Lexing araq
|
Parsing, Lexing araq
|
||||||
Renderer cooldome, araq
|
Renderer cooldome, araq
|
||||||
Order of passes cooldome
|
Order of passes cooldome
|
||||||
Semantic Checking araq
|
Semantic Checking araq
|
||||||
Virtual machine jangko, GULPF, araq
|
Virtual machine jangko, GULPF, araq
|
||||||
Sempass2: effects tracking cooldome, araq
|
Sempass2: effects tracking cooldome, araq
|
||||||
type system, concepts zahary
|
type system, concepts zahary
|
||||||
transf cooldome, araq
|
transf cooldome, araq
|
||||||
semfold constant folding araq
|
semfold constant folding araq
|
||||||
template instantiation zahary, araq
|
template instantiation zahary, araq
|
||||||
term rewriting macros cooldome, araq
|
term rewriting macros cooldome, araq
|
||||||
closure interators yglukhov, araq
|
closure iterators yglukhov, araq
|
||||||
lambda lifting yglukhov, araq
|
lambda lifting yglukhov, araq
|
||||||
c, cpp codegen lemonboy, araq
|
c, cpp codegen lemonboy, araq
|
||||||
js codegen yglukhov, lemonboy
|
js codegen yglukhov, lemonboy
|
||||||
alias analysis araq
|
alias analysis araq
|
||||||
dfa, writetracking araq
|
dfa, writetracking araq
|
||||||
parallel, multithreading araq
|
parallel, multithreading araq
|
||||||
incremental araq
|
incremental araq
|
||||||
sizeof computations krux02
|
sizeof computations krux02
|
||||||
Exception handling cooldome, araq
|
Exception handling cooldome, araq
|
||||||
====================== ======================================================
|
=========================== ======================================================
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -225,7 +225,7 @@ A sink parameter
|
||||||
*may* be consumed once in the proc's body but doesn't have to be consumed at all.
|
*may* be consumed once in the proc's body but doesn't have to be consumed at all.
|
||||||
The reason for this is that signatures
|
The reason for this is that signatures
|
||||||
like ``proc put(t: var Table; k: sink Key, v: sink Value)`` should be possible
|
like ``proc put(t: var Table; k: sink Key, v: sink Value)`` should be possible
|
||||||
without any further overloads and ``put`` might not take owership of ``k`` if
|
without any further overloads and ``put`` might not take ownership of ``k`` if
|
||||||
``k`` already exists in the table. Sink parameters enable an affine type system,
|
``k`` already exists in the table. Sink parameters enable an affine type system,
|
||||||
not a linear type system.
|
not a linear type system.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -244,7 +244,7 @@ Other Input Formats
|
||||||
|
|
||||||
The *Nim compiler* also has support for RST (reStructuredText) files with
|
The *Nim compiler* also has support for RST (reStructuredText) files with
|
||||||
the ``rst2html`` and ``rst2tex`` commands. Documents like this one are
|
the ``rst2html`` and ``rst2tex`` commands. Documents like this one are
|
||||||
initially written in a dialect of RST which adds support for nim sourcecode
|
initially written in a dialect of RST which adds support for nim source code
|
||||||
highlighting with the ``.. code-block:: nim`` prefix. ``code-block`` also
|
highlighting with the ``.. code-block:: nim`` prefix. ``code-block`` also
|
||||||
supports highlighting of C++ and some other c-like languages.
|
supports highlighting of C++ and some other c-like languages.
|
||||||
|
|
||||||
|
|
@ -330,7 +330,7 @@ Index (idx) file format
|
||||||
|
|
||||||
Files with the ``.idx`` extension are generated when you use the `Index
|
Files with the ``.idx`` extension are generated when you use the `Index
|
||||||
switch <#related-options-index-switch>`_ along with commands to generate
|
switch <#related-options-index-switch>`_ along with commands to generate
|
||||||
documentation from source or text files. You can programatically generate
|
documentation from source or text files. You can programmatically generate
|
||||||
indices with the `setIndexTerm()
|
indices with the `setIndexTerm()
|
||||||
<rstgen.html#setIndexTerm,RstGenerator,string,string,string,string,string>`_
|
<rstgen.html#setIndexTerm,RstGenerator,string,string,string,string,string>`_
|
||||||
and `writeIndexFile() <rstgen.html#writeIndexFile,RstGenerator,string>`_ procs.
|
and `writeIndexFile() <rstgen.html#writeIndexFile,RstGenerator,string>`_ procs.
|
||||||
|
|
@ -375,7 +375,7 @@ exception to this are table of content (TOC) entries. TOC entries are added to
|
||||||
the index file with their third column having as much prefix spaces as their
|
the index file with their third column having as much prefix spaces as their
|
||||||
level is in the TOC (at least 1 character). The prefix whitespace helps to
|
level is in the TOC (at least 1 character). The prefix whitespace helps to
|
||||||
filter TOC entries from API or text symbols. This is important because the
|
filter TOC entries from API or text symbols. This is important because the
|
||||||
amount of spaces is used to replicate the hiearchy for document TOCs in the
|
amount of spaces is used to replicate the hierarchy for document TOCs in the
|
||||||
final index, and TOC entries found in ``.nim`` files are discarded.
|
final index, and TOC entries found in ``.nim`` files are discarded.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -222,7 +222,7 @@ is a suitable place for implementing a program loop capable of calling
|
||||||
Please note that reloading won't be possible when any of the type definitions
|
Please note that reloading won't be possible when any of the type definitions
|
||||||
in the program has been changed. When closure iterators are used (directly or
|
in the program has been changed. When closure iterators are used (directly or
|
||||||
through async code), the reloaded definitions will affect only newly created
|
through async code), the reloaded definitions will affect only newly created
|
||||||
instances. Existing iterator instancess will execute their original code to
|
instances. Existing iterator instances will execute their original code to
|
||||||
completion.
|
completion.
|
||||||
|
|
||||||
JavaScript target
|
JavaScript target
|
||||||
|
|
|
||||||
|
|
@ -69,7 +69,7 @@ Or::
|
||||||
pass in the same value as **proj.nim**.
|
pass in the same value as **proj.nim**.
|
||||||
|
|
||||||
``DIRTY_FILE``
|
``DIRTY_FILE``
|
||||||
The **FILE** paramater is enough for static analysis, but IDEs
|
The **FILE** parameter is enough for static analysis, but IDEs
|
||||||
tend to have *unsaved buffers* where the user may still be in
|
tend to have *unsaved buffers* where the user may still be in
|
||||||
the middle of typing a line. In such situations the IDE can
|
the middle of typing a line. In such situations the IDE can
|
||||||
save the current contents to a temporary file and then use the
|
save the current contents to a temporary file and then use the
|
||||||
|
|
@ -210,7 +210,7 @@ tab characters (``\t``). The values of each column are:
|
||||||
def for definition, ``sug`` for suggestion, etc).
|
def for definition, ``sug`` for suggestion, etc).
|
||||||
2. Type of the symbol. This can be ``skProc``, ``skLet``, and just
|
2. Type of the symbol. This can be ``skProc``, ``skLet``, and just
|
||||||
about any of the enums defined in the module ``compiler/ast.nim``.
|
about any of the enums defined in the module ``compiler/ast.nim``.
|
||||||
3. Full qualitifed path of the symbol. If you are querying a symbol
|
3. Full qualified path of the symbol. If you are querying a symbol
|
||||||
defined in the ``proj.nim`` file, this would have the form
|
defined in the ``proj.nim`` file, this would have the form
|
||||||
``proj.symbolName``.
|
``proj.symbolName``.
|
||||||
4. Type/signature. For variables and enums this will contain the
|
4. Type/signature. For variables and enums this will contain the
|
||||||
|
|
|
||||||
|
|
@ -468,7 +468,7 @@ The CellSet data structure
|
||||||
The GC depends on an extremely efficient datastructure for storing a
|
The GC depends on an extremely efficient datastructure for storing a
|
||||||
set of pointers - this is called a ``TCellSet`` in the source code.
|
set of pointers - this is called a ``TCellSet`` in the source code.
|
||||||
Inserting, deleting and searching are done in constant time. However,
|
Inserting, deleting and searching are done in constant time. However,
|
||||||
modifying a ``TCellSet`` during traversation leads to undefined behaviour.
|
modifying a ``TCellSet`` during traversal leads to undefined behaviour.
|
||||||
|
|
||||||
.. code-block:: Nim
|
.. code-block:: Nim
|
||||||
type
|
type
|
||||||
|
|
@ -558,7 +558,7 @@ This means that a call through a closure generates an ``if`` but the
|
||||||
interoperability is worth the cost of the ``if``. Thunk generation would be
|
interoperability is worth the cost of the ``if``. Thunk generation would be
|
||||||
possible too, but it's slightly more effort to implement.
|
possible too, but it's slightly more effort to implement.
|
||||||
|
|
||||||
Tests with GCC on Amd64 showed that it's really beneficical if the
|
Tests with GCC on Amd64 showed that it's really beneficial if the
|
||||||
'environment' pointer is passed as the last argument, not as the first argument.
|
'environment' pointer is passed as the last argument, not as the first argument.
|
||||||
|
|
||||||
Proper thunk generation is harder because the proc that is to wrap
|
Proper thunk generation is harder because the proc that is to wrap
|
||||||
|
|
@ -609,7 +609,7 @@ Beware of nesting:
|
||||||
|
|
||||||
.. code-block:: nim
|
.. code-block:: nim
|
||||||
proc add(x: int): proc (y: int): proc (z: int): int {.closure.} {.closure.} =
|
proc add(x: int): proc (y: int): proc (z: int): int {.closure.} {.closure.} =
|
||||||
return lamba (y: int): proc (z: int): int {.closure.} =
|
return lambda (y: int): proc (z: int): int {.closure.} =
|
||||||
return lambda (z: int): int =
|
return lambda (z: int): int =
|
||||||
return x + y + z
|
return x + y + z
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -77,7 +77,7 @@ https://nim-lang.org.
|
||||||
|
|
||||||
By default the documentation will be built in parallel using the number of
|
By default the documentation will be built in parallel using the number of
|
||||||
available CPU cores. If any documentation build sub commands fail, they will
|
available CPU cores. If any documentation build sub commands fail, they will
|
||||||
be rerun in serial fashion so that meaninful error output can be gathered for
|
be rerun in serial fashion so that meaningful error output can be gathered for
|
||||||
inspection. The ``--parallelBuild:n`` switch or configuration option can be
|
inspection. The ``--parallelBuild:n`` switch or configuration option can be
|
||||||
used to force a specific number of parallel jobs or run everything serially
|
used to force a specific number of parallel jobs or run everything serially
|
||||||
from the start (``n == 1``).
|
from the start (``n == 1``).
|
||||||
|
|
|
||||||
|
|
@ -214,7 +214,7 @@ Generic Operating System Services
|
||||||
This module implements the ability to access symbols from shared libraries.
|
This module implements the ability to access symbols from shared libraries.
|
||||||
|
|
||||||
* `marshal <marshal.html>`_
|
* `marshal <marshal.html>`_
|
||||||
Contains procs for serialization and deseralization of arbitrary Nim
|
Contains procs for serialization and deserialization of arbitrary Nim
|
||||||
data structures.
|
data structures.
|
||||||
|
|
||||||
* `memfiles <memfiles.html>`_
|
* `memfiles <memfiles.html>`_
|
||||||
|
|
@ -267,7 +267,7 @@ Math libraries
|
||||||
Statistical analysis
|
Statistical analysis
|
||||||
|
|
||||||
* `std/sums <sums.html>`_
|
* `std/sums <sums.html>`_
|
||||||
Fast sumation functions.
|
Fast summation functions.
|
||||||
|
|
||||||
|
|
||||||
Internet Protocols and Support
|
Internet Protocols and Support
|
||||||
|
|
|
||||||
|
|
@ -6455,7 +6455,7 @@ Align pragma
|
||||||
The `align`:idx: pragma is for variables and object field members. It
|
The `align`:idx: pragma is for variables and object field members. It
|
||||||
modifies the alignment requirement of the entity being declared. The
|
modifies the alignment requirement of the entity being declared. The
|
||||||
argument must be a constant power of 2. Valid non-zero
|
argument must be a constant power of 2. Valid non-zero
|
||||||
alignments that are weaker than nother align pragmas on the same
|
alignments that are weaker than other align pragmas on the same
|
||||||
declaration are ignored. Alignments that are weaker that the
|
declaration are ignored. Alignments that are weaker that the
|
||||||
alignment requirement of the type are ignored.
|
alignment requirement of the type are ignored.
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -811,7 +811,7 @@ object inheritance syntax involving the ``of`` keyword:
|
||||||
|
|
||||||
.. code-block:: nim
|
.. code-block:: nim
|
||||||
type
|
type
|
||||||
Graph = concept g, type G of EqualyComparable, Copyable
|
Graph = concept g, type G of EquallyComparable, Copyable
|
||||||
type
|
type
|
||||||
VertexType = G.VertexType
|
VertexType = G.VertexType
|
||||||
EdgeType = G.EdgeType
|
EdgeType = G.EdgeType
|
||||||
|
|
|
||||||
|
|
@ -348,7 +348,7 @@ of your program.
|
||||||
proc glfmMain*(display: ptr GLFMDisplay) {.exportc.} =
|
proc glfmMain*(display: ptr GLFMDisplay) {.exportc.} =
|
||||||
NimMain() # initialize garbage collector memory, types and stack
|
NimMain() # initialize garbage collector memory, types and stack
|
||||||
|
|
||||||
Note: XCodes "make clean" gets confused about the genreated nim.c files,
|
Note: XCode's "make clean" gets confused about the generated nim.c files,
|
||||||
so you need to clean those files manually to do a clean build.
|
so you need to clean those files manually to do a clean build.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue