From a9974a33f10e380c1277d3cda296b7012033b2e5 Mon Sep 17 00:00:00 2001 From: Araq Date: Mon, 5 Mar 2018 23:25:34 +0100 Subject: [PATCH] more documentation fixes --- config/nimdoc.cfg | 2 +- doc/tools.txt | 4 ---- lib/pure/collections/sharedtables.nim | 12 +++++++----- web/website.ini | 4 ++-- 4 files changed, 10 insertions(+), 12 deletions(-) diff --git a/config/nimdoc.cfg b/config/nimdoc.cfg index 5fc9fdec5b..8e47264acf 100644 --- a/config/nimdoc.cfg +++ b/config/nimdoc.cfg @@ -75,7 +75,7 @@ doc.body_toc = """
- Search:
$tableofcontents diff --git a/doc/tools.txt b/doc/tools.txt index 7c9aed7ade..070deb8062 100644 --- a/doc/tools.txt +++ b/doc/tools.txt @@ -27,7 +27,3 @@ The standard distribution ships with the following tools: - | `estp `_ | Nim's slow platform independent embedded stack trace profiler. - -- | `nimfix `_ - | Nimfix is a tool to help you upgrade from Nimrod (<= version 0.9.6) to - Nim (=> version 0.10.0). diff --git a/lib/pure/collections/sharedtables.nim b/lib/pure/collections/sharedtables.nim index 4f311af874..0292a27a23 100644 --- a/lib/pure/collections/sharedtables.nim +++ b/lib/pure/collections/sharedtables.nim @@ -136,11 +136,13 @@ proc withKey*[A, B](t: var SharedTable[A, B], key: A, ## procedure. ## ## The ``mapper`` takes 3 arguments: - ## #. ``key`` - the current key, if it exists, or the key passed to - ## ``withKey`` otherwise; - ## #. ``val`` - the current value, if the key exists, or default value - ## of the type otherwise; - ## #. ``pairExists`` - ``true`` if the key exists, ``false`` otherwise. + ## + ## 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. + ## ## 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 diff --git a/web/website.ini b/web/website.ini index 9dc5949a06..ebfd5e6f27 100644 --- a/web/website.ini +++ b/web/website.ini @@ -29,8 +29,8 @@ news: news file: ticker.html [Documentation] -doc: "endb;intern;apis;lib;manual.rst;tut1.rst;tut2.rst;nimc;overview;filters" -doc: "tools;niminst;nimgrep;gc;estp;idetools;docgen;koch;backends.rst" +doc: "endb.rst;intern.txt;apis.txt;lib.rst;manual.rst;tut1.rst;tut2.rst;nimc.rst;overview.rst;filters.rst" +doc: "tools.txt;niminst.rst;nimgrep.rst;gc.rst;estp.rst;idetools.rst;docgen.rst;koch.rst;backends.rst" doc: "nimfix.rst;nimsuggest.rst;nep1.rst;nims.rst;contributing.rst" pdf: "manual.rst;lib.rst;tut1.rst;tut2.rst;nimc.rst;niminst.rst;gc.rst" srcdoc2: "system.nim;system/nimscript;pure/ospaths"