aboutsummaryrefslogtreecommitdiff
path: root/docs/templates/docs/design.rst
blob: b214229c3fd572b9c9df4d3ef71c372901c1b8a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
.. _module-MODULE_NAME-design:

======
Design
======
..
  This doc provides background on how a module works internally, the assumptions
  inherent in its design, why this particular design was chosen over others, and
  other topics of that nature.

  This doc is only required when the "Design considerations" section in the
  index becomes large enough that a separate doc is needed to maintain
  readability.  If *this* doc becomes too large, it can be replaced with a
  ``design`` subdirectory.