Skip to content

Commit 6d07299

Browse files
[Documentation] Add information on what not to document
1 parent 1d94c52 commit 6d07299

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

documentation/guidelines/content_guidelines.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,20 @@ documentation's scope. For example, you could link to an introduction to
5959
programming in the getting started guide, or a website that teaches math theory
6060
in the math section.
6161

62+
Finally it's also important to know what *not* to document; there are a some cases
63+
where things should be left out of the documentation to avoid causing problems.
64+
Some behaviors or details of how some part of the engine works might be unintentional,
65+
unknown to the maintainers, or be an implementation detail rather than part of the
66+
real goal of that feature. This means that these details might change when bugs are
67+
fixed or new features are added, as they are not part of the intended behavior or
68+
goal of the feature; so documenting them would risk making people rely on things
69+
that might change in the future if maintainers are not aware that this has been
70+
documented.
71+
72+
Anything that is documented is also generally considered part of the official API,
73+
meaning that changing it could be considered breaking compatibility, this risks
74+
limiting what changes can be done even when necessary.
75+
6276
Limiting cognitive load
6377
~~~~~~~~~~~~~~~~~~~~~~~
6478

0 commit comments

Comments
 (0)