clarifications

This commit is contained in:
conrad
2023-03-01 22:26:01 +10:00
parent 147091b0fd
commit c2e3cfaced
2 changed files with 9 additions and 7 deletions
+5 -4
View File
@@ -420,10 +420,11 @@ similar to [Semantic Versioning](https://semver.org/), as follows:
while remaining backwards compatible in as many cases as possible
(eg. major version 11 may have slightly different public API than major version 10).
**CAVEAT:** any function, class, constant or other code _not_ explicitly described
in the public API documentation is considered as part of the underlying internal
implementation details, and may change or be removed without notice.
(In other words, don't use internal functionality).
**CAVEAT:**
the above policy applies only to the public API described in the documentation.
Any functionality within Armadillo which is _not explicitly_ described
in the public API documentation is considered as internal implementation details,
and may be changed or removed without notice.
---
+4 -3
View File
@@ -19727,9 +19727,10 @@ However, to allow evolution, the public API may be altered in future major versi
</ul>
<br>
<li>
<b>Caveat:</b> any function, class, constant or other code <u>not</u> explicitly described in the public API documentation is considered as part of the underlying internal implementation details,
and may be removed or changed without notice.
(In other words, don't use internal functionality).
<b>Caveat:</b>
the above policy applies only to the public API described in the documentation.
Any functionality within Armadillo which is <u>not explicitly</u> described in the public API documentation is considered as internal implementation details,
and may be changed or removed without notice.
</li>
</ul>
</li>