Added missing modules to lib.txt and warnings to some module's docs.

This commit is contained in:
Dominik Picheta 2016-01-18 15:33:39 +00:00
commit d79a5f5276
9 changed files with 41 additions and 9 deletions

View file

@ -165,6 +165,8 @@ Generic Operating System Services
This module implements the ability to monitor a directory/file for changes This module implements the ability to monitor a directory/file for changes
using Posix's inotify API. using Posix's inotify API.
**Warning:** This module will likely be moved out to a Nimble package soon.
* `asyncfile <asyncfile.html>`_ * `asyncfile <asyncfile.html>`_
This module implements asynchronous file reading and writing using This module implements asynchronous file reading and writing using
``asyncdispatch``. ``asyncdispatch``.
@ -191,6 +193,11 @@ Math libraries
* `basic3d <basic3d.html>`_ * `basic3d <basic3d.html>`_
Basic 3d support with vectors, points, matrices and some basic utilities. Basic 3d support with vectors, points, matrices and some basic utilities.
* `mersenne <mersenne.html>`_
Mersenne twister random number generator.
* `stats <stats.html>`_
Statistical analysis
Internet Protocols and Support Internet Protocols and Support
------------------------------ ------------------------------
@ -209,7 +216,8 @@ Internet Protocols and Support
This module implements a simple HTTP server. This module implements a simple HTTP server.
* `httpclient <httpclient.html>`_ * `httpclient <httpclient.html>`_
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 <smtp.html>`_ * `smtp <smtp.html>`_
This module implement a simple SMTP client. This module implement a simple SMTP client.
@ -226,19 +234,17 @@ Internet Protocols and Support
* `asyncdispatch <asyncdispatch.html>`_ * `asyncdispatch <asyncdispatch.html>`_
This module implements an asynchronous dispatcher for IO operations. This module implements an asynchronous dispatcher for IO operations.
**Note:** This module is still largely experimental.
* `asyncnet <asyncnet.html>`_ * `asyncnet <asyncnet.html>`_
This module implements asynchronous sockets based on the ``asyncdispatch`` This module implements asynchronous sockets based on the ``asyncdispatch``
module. module.
**Note:** This module is still largely experimental.
* `asynchttpserver <asynchttpserver.html>`_ * `asynchttpserver <asynchttpserver.html>`_
This module implements an asynchronous HTTP server using the ``asyncnet`` This module implements an asynchronous HTTP server using the ``asyncnet``
module. module.
**Note:** This module is still largely experimental. * `asyncftpclient <asyncftpclient.html>`_
This module implements an asynchronous FTP client using the ``asyncnet``
module.
* `net <net.html>`_ * `net <net.html>`_
This module implements a high-level sockets API. It will replace the This module implements a high-level sockets API. It will replace the
@ -346,6 +352,8 @@ Cryptography and Hashing
* `base64 <base64.html>`_ * `base64 <base64.html>`_
This module implements a base64 encoder and decoder. This module implements a base64 encoder and decoder.
* `securehash <securehash.html>`_
This module implements a sha1 encoder and decoder.
Multimedia support Multimedia support
------------------ ------------------
@ -381,6 +389,11 @@ Miscellaneous
This module implements new experimental features. Currently the syntax This module implements new experimental features. Currently the syntax
sugar for anonymous procedures. sugar for anonymous procedures.
* `coro <coro.html>`_
This module implements experimental coroutines in Nim.
* `unittest <unittest.html>`_
Implements a Unit testing DSL.
Modules for JS backend Modules for JS backend
--------------------------- ---------------------------

View file

@ -10,6 +10,9 @@
## This module allows you to monitor files or directories for changes using ## This module allows you to monitor files or directories for changes using
## asyncio. ## asyncio.
## ##
## **Warning**: This module will likely disappear soon and be moved into a
## new Nimble package.
##
## Windows support is not yet implemented. ## Windows support is not yet implemented.
## ##
## **Note:** This module uses ``inotify`` on Linux (Other Unixes are not yet ## **Note:** This module uses ``inotify`` on Linux (Other Unixes are not yet

View file

@ -11,6 +11,8 @@
## key-value mapping. The keys are required to be strings, but the values ## 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 ## may be any Nim or user defined type. This module supports matching
## of keys in case-sensitive, case-insensitive and style-insensitive modes. ## of keys in case-sensitive, case-insensitive and style-insensitive modes.
##
## **Warning:** This module is deprecated, new code shouldn't use it!
{.deprecated.} {.deprecated.}

View file

@ -9,6 +9,9 @@
## This module implements a simple HTTP-Server. ## 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: ## Example:
## ##
## .. code-block:: nim ## .. code-block:: nim

View file

@ -7,6 +7,9 @@
# distribution, for details about the copyright. # 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 type OneVarFunction* = proc (x: float): float
{.deprecated: [TOneVarFunction: OneVarFunction].} {.deprecated: [TOneVarFunction: OneVarFunction].}

View file

@ -7,6 +7,9 @@
# distribution, for details about the copyright. # 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 math
import strutils import strutils
import numeric import numeric

View file

@ -9,6 +9,9 @@
## Module for converting an integer to a Roman numeral. ## Module for converting an integer to a Roman numeral.
## See http://en.wikipedia.org/wiki/Roman_numerals for reference. ## 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 const
RomanNumeralDigits* = {'I', 'i', 'V', 'v', 'X', 'x', 'L', 'l', 'C', 'c', RomanNumeralDigits* = {'I', 'i', 'V', 'v', 'X', 'x', 'L', 'l', 'C', 'c',

View file

@ -129,6 +129,8 @@ News
via a commit, for a full list see via a commit, for a full list see
`this link on Github <https://github.com/nim-lang/Nim/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%222015-10-27+..+2016-01-19%22+>`_. `this link on Github <https://github.com/nim-lang/Nim/issues?utf8=%E2%9C%93&q=is%3Aissue+closed%3A%222015-10-27+..+2016-01-19%22+>`_.
- Added missing modules to the documentation including ``coro``,
``securehash``, ``asyncftpclient``, ``mersenne`` and more.
- Fixed "Generic arguments cannot be used in templates (raising undeclared identifier)" - Fixed "Generic arguments cannot be used in templates (raising undeclared identifier)"
(`#3498 <https://github.com/nim-lang/Nim/issues/3498>`_) (`#3498 <https://github.com/nim-lang/Nim/issues/3498>`_)
- Fixed "multimethods: Error: internal error: cgmeth.genConv" - Fixed "multimethods: Error: internal error: cgmeth.genConv"

View file

@ -63,8 +63,8 @@ srcdoc2: "deprecated/pure/ftpclient"
srcdoc2: "pure/asyncfile;pure/asyncftpclient" srcdoc2: "pure/asyncfile;pure/asyncftpclient"
srcdoc2: "pure/md5;pure/rationals" srcdoc2: "pure/md5;pure/rationals"
srcdoc2: "posix/posix" srcdoc2: "posix/posix"
srcdoc2: "pure/fenv" srcdoc2: "pure/fenv;pure/securehash"
srcdoc2: "pure/basic2d;pure/basic3d" srcdoc2: "pure/basic2d;pure/basic3d;pure/mersenne;pure/coro"
; Note: everything under 'webdoc' doesn't get listed in the index, so wrappers ; Note: everything under 'webdoc' doesn't get listed in the index, so wrappers
; should live here ; should live here