Skip to content

Commit 5ca02ad

Browse files
committed
doc: add warning that design notes may be inaccurate
1 parent 4eab0e2 commit 5ca02ad

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/source/design.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,13 @@ Design notes
55

66
Developer notes on feature specifications and code design.
77

8+
.. warning:: The following notes have been written when the corresponding
9+
feature was being developed. Even if special care is given to update these
10+
notes later on, their content may not be in line with the current
11+
implementation details and behaviors. Please refer to the :ref:`module(1)`
12+
and :ref:`modulefile(5)` man pages to learn about current features and
13+
options.
14+
815
.. toctree::
916
:maxdepth: 1
1017
:glob:

0 commit comments

Comments
 (0)