From 0047f7cf4f97b59d1da65dbb8759319ebf2f13d4 Mon Sep 17 00:00:00 2001 From: Tristano Ajmone Date: Mon, 15 Jul 2019 19:05:23 +0200 Subject: [PATCH] Fix Typos in Internal Docs (#11735) [ci skip] (cherry picked from commit 8550a8127c6c80754d8a6f4300e4c77ee126e6ec) --- doc/docgen.rst | 2 +- doc/filelist.txt | 4 ++-- doc/intern.rst | 8 ++++---- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/docgen.rst b/doc/docgen.rst index bd7f9bf107..eb96992b85 100644 --- a/doc/docgen.rst +++ b/doc/docgen.rst @@ -220,7 +220,7 @@ Source URLs are generated as `href="${url}/tree/${commit}/${path}#L${line}"` by You can edit ``config/nimdoc.cfg`` and modify the ``doc.item.seesrc`` value with a hyperlink to your own code repository. In the case of Nim's own documentation, the ``commit`` value is just a commit -hash to append to a formatted URL to https://github.com/Araq/Nim. The +hash to append to a formatted URL to https://github.com/nim-lang/Nim. The ``tools/nimweb.nim`` helper queries the current git commit hash during doc generation, but since you might be working on an unpublished repository, it also allows specifying a ``githash`` value in ``web/website.ini`` to force a diff --git a/doc/filelist.txt b/doc/filelist.txt index 71379b40d1..c863ba0cf1 100644 --- a/doc/filelist.txt +++ b/doc/filelist.txt @@ -37,8 +37,8 @@ pragmas semantic checking of pragmas idents implements a general mapping from identifiers to an internal representation (``PIdent``) that is used so that a simple - id-comparison suffices to say whether two Nim identifiers - are equivalent + id-comparison suffices to establish whether two Nim + identifiers are equivalent ropes implements long strings represented as trees for lazy evaluation; used mainly by the code generators diff --git a/doc/intern.rst b/doc/intern.rst index 8e0df8fd38..db9a273adc 100644 --- a/doc/intern.rst +++ b/doc/intern.rst @@ -184,7 +184,7 @@ How the RTL is compiled The ``system`` module contains the part of the RTL which needs support by compiler magic (and the stuff that needs to be in it because the spec -says so). The C code generator generates the C code for it just like any other +says so). The C code generator generates the C code for it, just like any other module. However, calls to some procedures like ``addInt`` are inserted by the CCG. Therefore the module ``magicsys`` contains a table (``compilerprocs``) with all symbols that are marked as ``compilerproc``. ``compilerprocs`` are @@ -246,14 +246,14 @@ The symbol's ``ast`` field is loaded lazily, on demand. This is where most savings come from, only the shallow outer AST is reconstructed immediately. It is also important that the replay involves the ``import`` statement so -that the dependencies are resolved properly. +that dependencies are resolved properly. Shared global compiletime state ------------------------------- Nim allows ``.global, compiletime`` variables that can be filled by macro -invokations across different modules. This feature breaks modularity in a +invocations across different modules. This feature breaks modularity in a severe way. Plenty of different solutions have been proposed: - Restrict the types of global compiletime variables to ``Set[T]`` or @@ -286,7 +286,7 @@ We only know the root is ``someGlobal`` but the concrete path to the data is unknown as is the value that is added. We could compute a "diff" between the global states and use that to compute a symbol patchset, but this is quite some work, expensive to do at runtime (it would need to run after -every module has been compiled) and also would break for hash tables. +every module has been compiled) and would also break for hash tables. We need an API that hides the complex aliasing problems by not relying on Nim's global variables. The obvious solution is to use string keys