Add note to FileSequence.__str__ about format caveat (fixes #133)

justinfx · Apr 14, 2024 · 7745250 · 7745250
1 parent 6cc8b9a
commit 7745250
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 2 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -23,7 +23,7 @@ fileseq.filesequence module
     :members:
     :undoc-members:
     :show-inheritance:
-    :special-members: __getitem__, __iter__, __len__
+    :special-members: __str__, __getitem__, __iter__, __len__, __setstate__
 
 fileseq.frameset module
 -----------------------

diff --git a/src/fileseq/__version__.py b/src/fileseq/__version__.py
@@ -1 +1 @@
-__version__ = '2.0.0'
+__version__ = '2.1.1'
diff --git a/src/fileseq/filesequence.py b/src/fileseq/filesequence.py
@@ -759,6 +759,13 @@ def __str__(self):
         """
         String representation of this :class:`FileSequence`.
 
+        Note:
+            A FileSequence that does not define a frame range will omit
+            the padding character component when string formatted, even
+            if the padding character is set.
+            For more control over the exact string format, use the
+            :obj:`FileSequence.format()` method.
+
         Returns:
             str:
         """