summary refs log tree commit diff stats
path: root/lib/packages
diff options
context:
space:
mode:
authorMiran <narimiran@disroot.org>2019-02-19 12:49:09 +0100
committerGitHub <noreply@github.com>2019-02-19 12:49:09 +0100
commit8cf97908ccc9a344175f07ad459440b2290d5d6a (patch)
treed4cde01f6e1c32f7df1126ab98af38ecfbd3008f /lib/packages
parent6b9a139f7f27422bc2d7dc3fad20d589518a93b5 (diff)
downloadNim-8cf97908ccc9a344175f07ad459440b2290d5d6a.tar.gz
document proper imports, fixes #8164 (#10698)
Diffstat (limited to 'lib/packages')
-rw-r--r--lib/packages/docutils/highlite.nim2
-rw-r--r--lib/packages/docutils/rst.nim2
-rw-r--r--lib/packages/docutils/rstast.nim2
-rw-r--r--lib/packages/docutils/rstgen.nim2
4 files changed, 8 insertions, 0 deletions
diff --git a/lib/packages/docutils/highlite.nim b/lib/packages/docutils/highlite.nim
index 4d444603e..614b7176f 100644
--- a/lib/packages/docutils/highlite.nim
+++ b/lib/packages/docutils/highlite.nim
@@ -10,6 +10,8 @@
 ## Source highlighter for programming or markup languages.
 ## Currently only few languages are supported, other languages may be added.
 ## The interface supports one language nested in another.
+##
+## **Note:** Import ``packages/docutils/highlite`` to use this module
 
 import
   strutils
diff --git a/lib/packages/docutils/rst.nim b/lib/packages/docutils/rst.nim
index 023b159a0..615119135 100644
--- a/lib/packages/docutils/rst.nim
+++ b/lib/packages/docutils/rst.nim
@@ -10,6 +10,8 @@
 ## This module implements a `reStructuredText`:idx: parser. A large
 ## subset is implemented. Some features of the `markdown`:idx: wiki syntax are
 ## also supported.
+##
+## **Note:** Import ``packages/docutils/rst`` to use this module
 
 import
   os, strutils, rstast
diff --git a/lib/packages/docutils/rstast.nim b/lib/packages/docutils/rstast.nim
index fee824b09..044ea2c14 100644
--- a/lib/packages/docutils/rstast.nim
+++ b/lib/packages/docutils/rstast.nim
@@ -8,6 +8,8 @@
 #
 
 ## This module implements an AST for the `reStructuredText`:idx: parser.
+##
+## **Note:** Import ``packages/docutils/rstast`` to use this module
 
 import strutils, json
 
diff --git a/lib/packages/docutils/rstgen.nim b/lib/packages/docutils/rstgen.nim
index 766ce6ffd..85b40af4a 100644
--- a/lib/packages/docutils/rstgen.nim
+++ b/lib/packages/docutils/rstgen.nim
@@ -22,6 +22,8 @@
 ## other lower level methods to finally build complete documents. This requires
 ## many options and tweaking, but you are not limited to snippets and can
 ## generate `LaTeX documents <https://en.wikipedia.org/wiki/LaTeX>`_ too.
+##
+## **Note:** Import ``packages/docutils/rstgen`` to use this module
 
 import strutils, os, hashes, strtabs, rstast, rst, highlite, tables, sequtils,
   algorithm, parseutils