diff options
| -rw-r--r-- | doc/advopt.txt | 2 | ||||
| -rw-r--r-- | doc/docstyle.rst | 2 | ||||
| -rw-r--r-- | doc/intern.rst | 2 | ||||
| -rw-r--r-- | doc/manual.rst | 2 | ||||
| -rw-r--r-- | doc/manual_experimental.rst | 2 | ||||
| -rw-r--r-- | doc/nep1.rst | 2 | ||||
| -rw-r--r-- | doc/nimc.rst | 2 | ||||
| -rw-r--r-- | doc/subexes.txt | 2 |
8 files changed, 8 insertions, 8 deletions
diff --git a/doc/advopt.txt b/doc/advopt.txt index 60f5a1e10..85899031f 100644 --- a/doc/advopt.txt +++ b/doc/advopt.txt @@ -81,7 +81,7 @@ Advanced options: 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` --docCmd:cmd if `cmd == skip`, skips runnableExamples - else, runs runnableExamples with given options, eg: + else, runs runnableExamples with given options, e.g.: `--docCmd:"-d:foo --threads:on"` --docSeeSrcUrl:url activate 'see source' for doc and doc2 commands (see doc.item.seesrc in config/nimdoc.cfg) diff --git a/doc/docstyle.rst b/doc/docstyle.rst index 70ded0689..9a983097b 100644 --- a/doc/docstyle.rst +++ b/doc/docstyle.rst @@ -19,7 +19,7 @@ General Guidelines .. code-block:: nim proc someproc*(s: string, foo: int) = - ## Use single backticks for inline code, eg: `s` or `someExpr(true)`. + ## Use single backticks for inline code, e.g.: `s` or `someExpr(true)`. ## Use a backlash to follow with alphanumeric char: `int8`\s are great. diff --git a/doc/intern.rst b/doc/intern.rst index be183fd8e..89d477d09 100644 --- a/doc/intern.rst +++ b/doc/intern.rst @@ -125,7 +125,7 @@ you can rebuild the compiler as follows: A faster approach if you don't need to run the full bootstrapping implied by `koch boot`, is the following: * `pathto/nim c --lib:lib -d:release -o:bin/nim_temp compiler/nim.nim` -Where `pathto/nim` is any nim binary sufficiently recent (eg `bin/nim_cources` +Where `pathto/nim` is any nim binary sufficiently recent (e.g. `bin/nim_cources` built during bootstrap or `$HOME/.nimble/bin/nim` installed by `choosenim 1.2.0`) You can pass any additional options such as `-d:leanCompiler` if you don't need diff --git a/doc/manual.rst b/doc/manual.rst index 7258e7775..ddee5cabe 100644 --- a/doc/manual.rst +++ b/doc/manual.rst @@ -6707,7 +6707,7 @@ Example: embedsC() ``nimbase.h`` defines ``NIM_EXTERNC`` C macro that can be used for -``extern "C"`` code to work with both ``nim c`` and ``nim cpp``, eg: +``extern "C"`` code to work with both ``nim c`` and ``nim cpp``, e.g.: .. code-block:: Nim proc foobar() {.importc:"$1".} diff --git a/doc/manual_experimental.rst b/doc/manual_experimental.rst index 655adae02..caf3dfb48 100644 --- a/doc/manual_experimental.rst +++ b/doc/manual_experimental.rst @@ -1703,7 +1703,7 @@ noRewrite pragma Term rewriting macros and templates are currently greedy and they will rewrite as long as there is a match. There was no way to ensure some rewrite happens only once, -eg. when rewriting term to same term plus extra content. +e.g. when rewriting term to same term plus extra content. ``noRewrite`` pragma can actually prevent further rewriting on marked code, e.g. with given example ``echo("ab")`` will be rewritten just once: diff --git a/doc/nep1.rst b/doc/nep1.rst index 75343c85b..1ab45d680 100644 --- a/doc/nep1.rst +++ b/doc/nep1.rst @@ -149,7 +149,7 @@ changed in the future. an in-place version should get an ``-In`` suffix (``replaceIn`` for this example). -- Use `subjectVerb`, not `verbSubject`, eg: `fileExists`, not `existsFile`. +- Use `subjectVerb`, not `verbSubject`, e.g.: `fileExists`, not `existsFile`. The stdlib API is designed to be **easy to use** and consistent. Ease of use is measured by the number of calls to achieve a concrete high level action. The diff --git a/doc/nimc.rst b/doc/nimc.rst index 379d8b559..9a698312b 100644 --- a/doc/nimc.rst +++ b/doc/nimc.rst @@ -423,7 +423,7 @@ complete list. Define Effect ====================== ========================================================= ``release`` Turns on the optimizer. - More aggressive optimizations are possible, eg: + More aggressive optimizations are possible, e.g.: ``--passC:-ffast-math`` (but see issue #10305) ``danger`` Turns off all runtime checks and turns on the optimizer. ``useFork`` Makes ``osproc`` use ``fork`` instead of ``posix_spawn``. diff --git a/doc/subexes.txt b/doc/subexes.txt index 54304f033..62ddd1ec8 100644 --- a/doc/subexes.txt +++ b/doc/subexes.txt @@ -14,7 +14,7 @@ Notation meaning ===================== ===================================================== ``$#`` use first or next argument ``$name`` use named argument, you can wrap the named argument - in curly braces (eg. ``${name}``) to separate it from + in curly braces (e.g. ``${name}``) to separate it from the next characters. ``$$`` produces a single ``$`` ``$1`` use first argument |