summary refs log tree commit diff stats
path: root/lib
diff options
context:
space:
mode:
Diffstat (limited to 'lib')
-rw-r--r--lib/deprecated/pure/mersenne.nim (renamed from lib/pure/mersenne.nim)0
-rw-r--r--lib/deprecated/pure/oswalkdir.nim (renamed from lib/pure/oswalkdir.nim)0
-rw-r--r--lib/deprecated/pure/sums.nim (renamed from lib/std/sums.nim)0
-rw-r--r--lib/pure/async.nim3
-rw-r--r--lib/pure/asyncdispatch.nim3
-rw-r--r--lib/pure/asyncmacro.nim2
-rw-r--r--lib/pure/math.nim1
-rw-r--r--lib/pure/random.nim1
-rw-r--r--lib/pure/reservedmem.nim2
-rw-r--r--lib/std/appdirs.nim2
-rw-r--r--lib/std/decls.nim3
-rw-r--r--lib/std/dirs.nim2
-rw-r--r--lib/std/envvars.nim2
-rw-r--r--lib/std/exitprocs.nim2
-rw-r--r--lib/std/files.nim2
-rw-r--r--lib/std/formatfloat.nim2
-rw-r--r--lib/std/genasts.nim2
-rw-r--r--lib/std/jsfetch.nim5
-rw-r--r--lib/std/jsonutils.nim2
-rw-r--r--lib/std/objectdollar.nim2
-rw-r--r--lib/std/paths.nim2
-rw-r--r--lib/std/symlinks.nim2
-rw-r--r--lib/std/widestrs.nim2
23 files changed, 32 insertions, 12 deletions
diff --git a/lib/pure/mersenne.nim b/lib/deprecated/pure/mersenne.nim
index 37c5085b1..37c5085b1 100644
--- a/lib/pure/mersenne.nim
+++ b/lib/deprecated/pure/mersenne.nim
diff --git a/lib/pure/oswalkdir.nim b/lib/deprecated/pure/oswalkdir.nim
index 866f9ed70..866f9ed70 100644
--- a/lib/pure/oswalkdir.nim
+++ b/lib/deprecated/pure/oswalkdir.nim
diff --git a/lib/std/sums.nim b/lib/deprecated/pure/sums.nim
index a6ce1b85d..a6ce1b85d 100644
--- a/lib/std/sums.nim
+++ b/lib/deprecated/pure/sums.nim
diff --git a/lib/pure/async.nim b/lib/pure/async.nim
index 482ab32c6..249c5f639 100644
--- a/lib/pure/async.nim
+++ b/lib/pure/async.nim
@@ -1,3 +1,6 @@
+## Exports [asyncmacro](asyncmacro.html) and [asyncfutures](asyncfutures.html) for native backends,
+## and [asyncjs](asyncjs.html) on the JS backend. 
+
 when defined(js):
   import asyncjs
   export asyncjs
diff --git a/lib/pure/asyncdispatch.nim b/lib/pure/asyncdispatch.nim
index 38b93e213..214b7d12c 100644
--- a/lib/pure/asyncdispatch.nim
+++ b/lib/pure/asyncdispatch.nim
@@ -1983,7 +1983,8 @@ proc send*(socket: AsyncFD, data: string,
   return retFuture
 
 # -- Await Macro
-include asyncmacro
+import asyncmacro
+export asyncmacro
 
 proc readAll*(future: FutureStream[string]): owned(Future[string]) {.async.} =
   ## Returns a future that will complete when all the string data from the
diff --git a/lib/pure/asyncmacro.nim b/lib/pure/asyncmacro.nim
index d85e3e621..7ee324369 100644
--- a/lib/pure/asyncmacro.nim
+++ b/lib/pure/asyncmacro.nim
@@ -7,7 +7,7 @@
 #    distribution, for details about the copyright.
 #
 
-## `asyncdispatch` module depends on the `asyncmacro` module to work properly.
+## Implements the `async` and `multisync` macros for `asyncdispatch`.
 
 import macros, strutils, asyncfutures
 
diff --git a/lib/pure/math.nim b/lib/pure/math.nim
index 15324f882..bea655a0e 100644
--- a/lib/pure/math.nim
+++ b/lib/pure/math.nim
@@ -47,7 +47,6 @@ runnableExamples:
 ## * `fenv module <fenv.html>`_ for handling of floating-point rounding
 ##   and exceptions (overflow, zero-divide, etc.)
 ## * `random module <random.html>`_ for a fast and tiny random number generator
-## * `mersenne module <mersenne.html>`_ for the Mersenne Twister random number generator
 ## * `stats module <stats.html>`_ for statistical analysis
 ## * `strformat module <strformat.html>`_ for formatting floats for printing
 ## * `system module <system.html>`_ for some very basic and trivial math operators
diff --git a/lib/pure/random.nim b/lib/pure/random.nim
index 9418924da..c36ab445b 100644
--- a/lib/pure/random.nim
+++ b/lib/pure/random.nim
@@ -66,7 +66,6 @@ runnableExamples:
 ## See also
 ## ========
 ## * `std/sysrand module <sysrand.html>`_ for a cryptographically secure pseudorandom number generator
-## * `mersenne module <mersenne.html>`_ for the Mersenne Twister random number generator
 ## * `math module <math.html>`_ for basic math routines
 ## * `stats module <stats.html>`_ for statistical analysis
 ## * `list of cryptographic and hashing modules <lib.html#pure-libraries-hashing>`_
diff --git a/lib/pure/reservedmem.nim b/lib/pure/reservedmem.nim
index bf14fc574..528b0095c 100644
--- a/lib/pure/reservedmem.nim
+++ b/lib/pure/reservedmem.nim
@@ -9,7 +9,7 @@
 
 ## :Authors: Zahary Karadjov
 ##
-## This module provides utilities for reserving a portions of the
+## This module provides utilities for reserving portions of the
 ## address space of a program without consuming physical memory.
 ## It can be used to implement a dynamically resizable buffer that
 ## is guaranteed to remain in the same memory location. The buffer
diff --git a/lib/std/appdirs.nim b/lib/std/appdirs.nim
index 51e8fddac..e648fe0c1 100644
--- a/lib/std/appdirs.nim
+++ b/lib/std/appdirs.nim
@@ -1,3 +1,5 @@
+## This module implements helpers for determining special directories used by apps.
+
 from std/private/osappdirs import nil
 import std/paths
 import std/envvars
diff --git a/lib/std/decls.nim b/lib/std/decls.nim
index fc202522f..3f774cd08 100644
--- a/lib/std/decls.nim
+++ b/lib/std/decls.nim
@@ -1,5 +1,4 @@
-# see `semLowerLetVarCustomPragma` for compiler support that enables these
-# lowerings
+## This module implements syntax sugar for some declarations.
 
 import macros
 
diff --git a/lib/std/dirs.nim b/lib/std/dirs.nim
index adab9e9dd..df6107c51 100644
--- a/lib/std/dirs.nim
+++ b/lib/std/dirs.nim
@@ -1,3 +1,5 @@
+## This module implements directory handling.
+
 from paths import Path, ReadDirEffect, WriteDirEffect
 
 from std/private/osdirs import dirExists, createDir, existsOrCreateDir, removeDir,
diff --git a/lib/std/envvars.nim b/lib/std/envvars.nim
index d86f13f8d..46595a3cf 100644
--- a/lib/std/envvars.nim
+++ b/lib/std/envvars.nim
@@ -8,7 +8,7 @@
 #
 
 
-## The `std/envvars` module implements environment variables handling.
+## The `std/envvars` module implements environment variable handling.
 import std/oserrors
 
 type
diff --git a/lib/std/exitprocs.nim b/lib/std/exitprocs.nim
index c6537f7f8..d63c1abc5 100644
--- a/lib/std/exitprocs.nim
+++ b/lib/std/exitprocs.nim
@@ -7,6 +7,8 @@
 #    distribution, for details about the copyright.
 #
 
+## This module allows adding hooks to program exit.
+
 import locks
 
 type
diff --git a/lib/std/files.nim b/lib/std/files.nim
index 5bc7f7965..138bb5234 100644
--- a/lib/std/files.nim
+++ b/lib/std/files.nim
@@ -1,3 +1,5 @@
+## This module implements file handling.
+
 from paths import Path, ReadDirEffect, WriteDirEffect
 
 from std/private/osfiles import fileExists, removeFile,
diff --git a/lib/std/formatfloat.nim b/lib/std/formatfloat.nim
index 01b88d813..8abbe59cd 100644
--- a/lib/std/formatfloat.nim
+++ b/lib/std/formatfloat.nim
@@ -7,6 +7,8 @@
 #    distribution, for details about the copyright.
 #
 
+## This module implements formatting floats as strings.
+
 when defined(nimPreviewSlimSystem):
   import std/assertions
 else:
diff --git a/lib/std/genasts.nim b/lib/std/genasts.nim
index c5f51e5d9..05b2823ef 100644
--- a/lib/std/genasts.nim
+++ b/lib/std/genasts.nim
@@ -1,3 +1,5 @@
+## This module implements AST generation using captured variables for macros.
+
 import macros
 
 type GenAstOpt* = enum
diff --git a/lib/std/jsfetch.nim b/lib/std/jsfetch.nim
index 988414258..219594619 100644
--- a/lib/std/jsfetch.nim
+++ b/lib/std/jsfetch.nim
@@ -2,7 +2,8 @@
 when not defined(js):
   {.fatal: "Module jsfetch is designed to be used with the JavaScript backend.".}
 
-import std/[asyncjs, jsheaders, jsformdata]
+import std/[asyncjs, jsformdata, jsheaders]
+export jsformdata, jsheaders
 from std/httpcore import HttpMethod
 from std/jsffi import JsObject
 
@@ -116,7 +117,7 @@ func `$`*(self: Request | Response | FetchOptions): string = $toCstring(self)
 
 
 runnableExamples("-r:off"):
-  import std/[asyncjs, jsconsole, jsheaders, jsformdata]
+  import std/[asyncjs, jsconsole, jsformdata, jsheaders]
   from std/httpcore import HttpMethod
   from std/jsffi import JsObject
   from std/sugar import `=>`
diff --git a/lib/std/jsonutils.nim b/lib/std/jsonutils.nim
index 49367dac3..eec8dea7d 100644
--- a/lib/std/jsonutils.nim
+++ b/lib/std/jsonutils.nim
@@ -1,5 +1,5 @@
 ##[
-This module implements a hookable (de)serialization for arbitrary types.
+This module implements a hookable (de)serialization for arbitrary types using JSON.
 Design goal: avoid importing modules where a custom serialization is needed;
 see strtabs.fromJsonHook,toJsonHook for an example.
 ]##
diff --git a/lib/std/objectdollar.nim b/lib/std/objectdollar.nim
index f413bbc46..86ce9afc8 100644
--- a/lib/std/objectdollar.nim
+++ b/lib/std/objectdollar.nim
@@ -1,3 +1,5 @@
+## This module implements a generic `$` operator to convert objects to strings.
+
 import std/private/miscdollars
 
 proc `$`*[T: object](x: T): string =
diff --git a/lib/std/paths.nim b/lib/std/paths.nim
index 59f7653c8..c29096982 100644
--- a/lib/std/paths.nim
+++ b/lib/std/paths.nim
@@ -1,3 +1,5 @@
+## This module implements path handling.
+
 import std/private/osseps
 export osseps
 
diff --git a/lib/std/symlinks.nim b/lib/std/symlinks.nim
index cb469d8c3..9e77bbe2a 100644
--- a/lib/std/symlinks.nim
+++ b/lib/std/symlinks.nim
@@ -1,3 +1,5 @@
+## This module implements symlink (symbolic link) handling.
+
 from paths import Path, ReadDirEffect
 
 from std/private/ossymlinks import symlinkExists, createSymlink, expandSymlink
diff --git a/lib/std/widestrs.nim b/lib/std/widestrs.nim
index f0f648c8d..8973579e1 100644
--- a/lib/std/widestrs.nim
+++ b/lib/std/widestrs.nim
@@ -7,7 +7,7 @@
 #    distribution, for details about the copyright.
 #
 
-# Nim support for C/C++'s `wide strings`:idx:.
+## Nim support for C/C++'s `wide strings`:idx:.
 
 #when not declared(ThisIsSystem):
 #  {.error: "You must not import this module explicitly".}
generated by cgit-pink 1.4.1-2-gfad0 (git 2.36.2.497.gbbea4dcf42) at 2025-02-04 14:01:54 +0000