From 0d1be876d9c57da15cec55bcf8394f0e1dcb2a3e Mon Sep 17 00:00:00 2001
From: Demian Vladi <demian.vladi@axleinfo.com>
Date: Thu, 18 Jun 2026 12:20:56 -0700
Subject: [PATCH] fix: use raw docstrings to silence invalid escape sequence
 SyntaxWarning
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Several docstrings in Nyxus, Nyxus3D, ImageQuality, and Nested contain \pi and regex examples with \. — invalid escape sequences that trigger SyntaxWarning on Python 3.12+. Mark the affected docstrings raw (r") so the backslashes are treated as literal text, with no change to the rendered documentation.

Co-authored-by: Demian Vladi <demian.vladi@axleinfo.com>
---
 src/nyx/python/nyxus/nyxus.py | 22 +++++++++++-----------
 1 file changed, 11 insertions(+), 11 deletions(-)

diff --git a/src/nyx/python/nyxus/nyxus.py b/src/nyx/python/nyxus/nyxus.py
index 646d458e..3f052eb5 100644
--- a/src/nyx/python/nyxus/nyxus.py
+++ b/src/nyx/python/nyxus/nyxus.py
@@ -27,7 +27,7 @@
 from typing import Optional, List
 
 class Nyxus:
-    """Nyxus image feature extraction library
+    r"""Nyxus image feature extraction library
 
     Scalably extracts features from images.
     
@@ -614,7 +614,7 @@ def roi_blacklist_get_summary (self):
         return s
     
     def set_gabor_feature_params (self, **kwargs):
-        """Sets parameters of feature GABOR
+        r"""Sets parameters of feature GABOR
 
         Keyword args:
         * kersize (int): size of filter kernel's side. Example: customize_gabor_feature(kersize=16)
@@ -731,7 +731,7 @@ def set_environment_params (self, **params):
                                    verb_lvl)
         
     def set_params(self, **params):
-        """Sets parameters of the Nyxus class
+        r"""Sets parameters of the Nyxus class
 
         Keyword args:
         
@@ -795,7 +795,7 @@ def set_params(self, **params):
 
 
     def get_params(self, *args):
-        """Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
+        r"""Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
         
         Valid parameters are:
         
@@ -1292,7 +1292,7 @@ def set_environment_params (self, **params):
                                    verb_lvl)
         
     def set_params(self, **params):
-        """Sets parameters of the Nyxus class
+        r"""Sets parameters of the Nyxus class
 
         Keyword args:
         
@@ -1343,7 +1343,7 @@ def set_params(self, **params):
             self.set_environment_params(**environment_params)
     
     def get_params(self, *args):
-        """Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
+        r"""Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
         
         Valid parameters are:
         
@@ -1910,7 +1910,7 @@ def roi_blacklist_get_summary (self):
         return s
     
     def set_gabor_feature_params (self, **kwargs):
-        """Sets parameters of feature GABOR
+        r"""Sets parameters of feature GABOR
 
         Keyword args:
         * kersize (int): size of filter kernel's side. Example: customize_gabor_feature(kersize=16)
@@ -2026,7 +2026,7 @@ def set_environment_params (self, **params):
                                    verb_lvl)
         
     def set_params(self, **params):
-        """Sets parameters of the Nyxus class
+        r"""Sets parameters of the Nyxus class
 
         Keyword args:
         
@@ -2090,7 +2090,7 @@ def set_params(self, **params):
             self.set_environment_params(**environment_params)
     
     def get_params(self, *args):
-        """Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
+        r"""Returns the parameters of a Nyxus object. If no args are supplied, all parameters will be returned.
         
         Valid parameters are:
         
@@ -2126,7 +2126,7 @@ def get_params(self, *args):
 
 
 class Nested:
-    """Nyxus image feature extraction library / ROI hierarchy analyzer
+    r"""Nyxus image feature extraction library / ROI hierarchy analyzer
     
     Valid aggregate functions are any functions available in pandas.DatFrame.aggregate,
     e.g. min, max, count, std. Lambda functions can also be passed. To provide a name to
@@ -2171,7 +2171,7 @@ def find_relations(
         parent_file_pattern: str, 
         child_file_pattern: str):
     
-        """Finds parent-child relationships.
+        r"""Finds parent-child relationships.
 
         Find parent-child relationships of parent files matching the parent_file_pattern
         and child files matching the child_file_pattern.