diff --git a/doc/lib.txt b/doc/lib.txt index 4fa49095c2..90cf36240f 100644 --- a/doc/lib.txt +++ b/doc/lib.txt @@ -84,7 +84,7 @@ Collections and algorithms * `sequtils `_ This module implements operations for the built-in seq type which were inspired by functional programming languages. - + String handling --------------- @@ -165,6 +165,8 @@ Generic Operating System Services This module implements the ability to monitor a directory/file for changes using Posix's inotify API. + **Warning:** This module will likely be moved out to a Nimble package soon. + * `asyncfile `_ This module implements asynchronous file reading and writing using ``asyncdispatch``. @@ -191,6 +193,11 @@ Math libraries * `basic3d `_ Basic 3d support with vectors, points, matrices and some basic utilities. +* `mersenne `_ + Mersenne twister random number generator. + +* `stats `_ + Statistical analysis Internet Protocols and Support ------------------------------ @@ -209,7 +216,8 @@ Internet Protocols and Support This module implements a simple HTTP server. * `httpclient `_ - This module implements a simple HTTP client. + This module implements a simple HTTP client which supports both synchronous + and asynchronous retrieval of web pages. * `smtp `_ This module implement a simple SMTP client. @@ -226,19 +234,17 @@ Internet Protocols and Support * `asyncdispatch `_ This module implements an asynchronous dispatcher for IO operations. - **Note:** This module is still largely experimental. - * `asyncnet `_ This module implements asynchronous sockets based on the ``asyncdispatch`` module. - **Note:** This module is still largely experimental. - * `asynchttpserver `_ This module implements an asynchronous HTTP server using the ``asyncnet`` module. - **Note:** This module is still largely experimental. +* `asyncftpclient `_ + This module implements an asynchronous FTP client using the ``asyncnet`` + module. * `net `_ This module implements a high-level sockets API. It will replace the @@ -346,6 +352,8 @@ Cryptography and Hashing * `base64 `_ This module implements a base64 encoder and decoder. +* `securehash `_ + This module implements a sha1 encoder and decoder. Multimedia support ------------------ @@ -381,6 +389,11 @@ Miscellaneous This module implements new experimental features. Currently the syntax sugar for anonymous procedures. +* `coro `_ + This module implements experimental coroutines in Nim. + +* `unittest `_ + Implements a Unit testing DSL. Modules for JS backend --------------------------- diff --git a/lib/pure/fsmonitor.nim b/lib/pure/fsmonitor.nim index 115c4739e7..b22e84f446 100644 --- a/lib/pure/fsmonitor.nim +++ b/lib/pure/fsmonitor.nim @@ -10,6 +10,9 @@ ## This module allows you to monitor files or directories for changes using ## asyncio. ## +## **Warning**: This module will likely disappear soon and be moved into a +## new Nimble package. +## ## Windows support is not yet implemented. ## ## **Note:** This module uses ``inotify`` on Linux (Other Unixes are not yet diff --git a/lib/pure/gentabs.nim b/lib/pure/gentabs.nim index e6a05ec638..928ff8fe03 100644 --- a/lib/pure/gentabs.nim +++ b/lib/pure/gentabs.nim @@ -11,6 +11,8 @@ ## key-value mapping. The keys are required to be strings, but the values ## may be any Nim or user defined type. This module supports matching ## of keys in case-sensitive, case-insensitive and style-insensitive modes. +## +## **Warning:** This module is deprecated, new code shouldn't use it! {.deprecated.} diff --git a/lib/pure/httpserver.nim b/lib/pure/httpserver.nim index 71ba049919..632eb198a1 100644 --- a/lib/pure/httpserver.nim +++ b/lib/pure/httpserver.nim @@ -9,6 +9,9 @@ ## This module implements a simple HTTP-Server. ## +## **Warning**: This module will soon be deprecated in favour of +## the ``asyncdispatch`` module, you should use it instead. +## ## Example: ## ## .. code-block:: nim diff --git a/lib/pure/numeric.nim b/lib/pure/numeric.nim index 71adf19b36..ccda3a146a 100644 --- a/lib/pure/numeric.nim +++ b/lib/pure/numeric.nim @@ -7,6 +7,9 @@ # distribution, for details about the copyright. # +## **Warning:** This module will be moved out of the stdlib and into a +## Nimble package, don't use it. + type OneVarFunction* = proc (x: float): float {.deprecated: [TOneVarFunction: OneVarFunction].} diff --git a/lib/pure/poly.nim b/lib/pure/poly.nim index c523004005..b20e9f9d01 100644 --- a/lib/pure/poly.nim +++ b/lib/pure/poly.nim @@ -7,6 +7,9 @@ # distribution, for details about the copyright. # +## **Warning:** This module will be moved out of the stdlib and into a +## Nimble package, don't use it. + import math import strutils import numeric diff --git a/lib/pure/romans.nim b/lib/pure/romans.nim index 18c04ef58e..aa047d1cce 100644 --- a/lib/pure/romans.nim +++ b/lib/pure/romans.nim @@ -9,6 +9,9 @@ ## Module for converting an integer to a Roman numeral. ## See http://en.wikipedia.org/wiki/Roman_numerals for reference. +## +## **Warning:** This module will be moved out of the stdlib and into a +## Nimble package, don't use it. const RomanNumeralDigits* = {'I', 'i', 'V', 'v', 'X', 'x', 'L', 'l', 'C', 'c', diff --git a/web/news.txt b/web/news.txt index fd92e1ad20..f1744a1df1 100644 --- a/web/news.txt +++ b/web/news.txt @@ -129,6 +129,8 @@ News via a commit, for a full list see `this link on Github `_. + - Added missing modules to the documentation including ``coro``, + ``securehash``, ``asyncftpclient``, ``mersenne`` and more. - Fixed "Generic arguments cannot be used in templates (raising undeclared identifier)" (`#3498 `_) - Fixed "multimethods: Error: internal error: cgmeth.genConv" diff --git a/web/website.ini b/web/website.ini index 6343193d50..712fcd07c2 100644 --- a/web/website.ini +++ b/web/website.ini @@ -63,8 +63,8 @@ srcdoc2: "deprecated/pure/ftpclient" srcdoc2: "pure/asyncfile;pure/asyncftpclient" srcdoc2: "pure/md5;pure/rationals" srcdoc2: "posix/posix" -srcdoc2: "pure/fenv" -srcdoc2: "pure/basic2d;pure/basic3d" +srcdoc2: "pure/fenv;pure/securehash" +srcdoc2: "pure/basic2d;pure/basic3d;pure/mersenne;pure/coro" ; Note: everything under 'webdoc' doesn't get listed in the index, so wrappers ; should live here