Added breaking changes documentation

SigmaHQ · Oct 25, 2024 · 32e5b08 · 32e5b08
1 parent 9debf09
commit 32e5b08
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/Breaking_Changes.rst b/docs/Breaking_Changes.rst
@@ -0,0 +1,13 @@
+Breaking Changes
+================
+
+This page documents breaking changes in pySigma. Normally, we try to avoid breaking changes in minor
+versions and generally try to keep pySigma backwards compatible, but sometimes they are necessary to
+improve the library.
+
+Version 1.0
+-----------
+
+* The class `CompareOperators` was moved out of `SigmaCompatreExpression` into the root of the
+  containing module `sigma.types`. If the class was formerly used, it has now to be imported
+  explicitly from the module.
diff --git a/docs/index.rst b/docs/index.rst
@@ -10,6 +10,7 @@ pySigma Documentation
    Backends
    Rule_Validation
    Plugin_System
+   Breaking_Changes
 
 Overview
 ********