summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMatthew Peveler <matt.peveler@gmail.com>2021-02-01 01:42:34 +0000
committerMatthew Peveler <matt.peveler@gmail.com>2021-02-01 01:42:34 +0000
commit3d9c5e4206ab88aa58750b5fffaf4e83700ad951 (patch)
tree456ed969863e95bfd72af732582cae83905f7c41
parentd569713adba1325930e35eba7ee5c47d0749e0d6 (diff)
downloadasciidoc-py3-3d9c5e4206ab88aa58750b5fffaf4e83700ad951.tar.gz
add notice on expected BC breaks of asciidoc and a2x module internals
Signed-off-by: Matthew Peveler <matt.peveler@gmail.com>
-rw-r--r--asciidoc/a2x.py4
-rw-r--r--asciidoc/asciidoc.py5
2 files changed, 9 insertions, 0 deletions
diff --git a/asciidoc/a2x.py b/asciidoc/a2x.py
index 4a23293..4ba261e 100644
--- a/asciidoc/a2x.py
+++ b/asciidoc/a2x.py
@@ -28,6 +28,10 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
"""
+# Please note, the contents of this module are considered "private" and may
+# change within the 10.0+ releases. If you come to depend on a specific method
+# or class, please leave a GitHub issue stating as much.
+
import io
import os
import fnmatch
diff --git a/asciidoc/asciidoc.py b/asciidoc/asciidoc.py
index b26a4c6..b4cd588 100644
--- a/asciidoc/asciidoc.py
+++ b/asciidoc/asciidoc.py
@@ -10,6 +10,11 @@ Free use of this software is granted under the terms of the GNU General
Public License version 2 (GPLv2).
"""
+# Please note, the contents of this module are considered "private" with the
+# exception of cli() and execute() and so may change within the 10.0+ releases.
+# If you come to depend on a specific method or class, please leave a GitHub
+# issue stating as much so as to help prevent breaking changes to your toolchain.
+
import ast
import copy
import csv