docs: add warning to private objects that their API might change without

notice see #1013
obspy · Nov 18, 2015 · 3e0e86c · 3e0e86c
1 parent 23b7a4b
commit 3e0e86c
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/misc/docs/source/_templates/autosummary/class.rst b/misc/docs/source/_templates/autosummary/class.rst
@@ -46,6 +46,10 @@
   {% if private_methods %}
   .. rubric:: Private Methods
 
+  .. warning::
+
+       Private methods are mainly for internal/developer use and their API might change without notice.
+
   .. autosummary::
     :toctree: .
     :nosignatures:

diff --git a/misc/docs/source/_templates/autosummary/module.rst b/misc/docs/source/_templates/autosummary/module.rst
@@ -33,6 +33,10 @@
    {% if private_functions %}
    .. rubric:: Private Functions
 
+   .. warning::
+
+       Private functions are mainly for internal/developer use and their API might change without notice.
+
    .. autosummary::
      :toctree: .
      :nosignatures: