add some notes to prevent accidental breaking changes.

rollbar · Mar 20, 2023 · 80eeabe · 80eeabe
1 parent 4da8f78
commit 80eeabe
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/rollbar/lib/transforms/__init__.py b/rollbar/lib/transforms/__init__.py
@@ -14,6 +14,8 @@
     traverse,
     type_info,
 )
+# NOTE: Don't remove this import, it would cause a breaking change to the library's API.
+# The `Transform` class was moved out of this file to prevent a cyclical dependency issue.
 from rollbar.lib.transform import Transform
 from rollbar.lib.transforms.batched import BatchedTransform
 

diff --git a/rollbar/lib/traverse.py b/rollbar/lib/traverse.py
@@ -2,6 +2,10 @@
 
 
 from rollbar.lib import binary_type, iteritems, string_types, circular_reference_label
+
+# NOTE: Don't remove this line of code as it would cause a breaking change
+# to the library's API. The items imported here were originally in this file
+# but were moved to a new file for easier use elsewhere.
 from rollbar.lib.type_info import (
     get_type,
     CIRCULAR,