python-redlines 0.2.0__tar.gz → 0.2.1__tar.gz

{python_redlines-0.2.0 → python_redlines-0.2.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-redlines
-Version: 0.2.0
+Version: 0.2.1
 Summary: Generate tracked-change redline .docx documents by comparing Word files.
 Project-URL: Homepage, https://github.com/JSv4/Python-Redlines
 Project-URL: Issues, https://github.com/JSv4/Python-Redlines/issues

{python_redlines-0.2.0 → python_redlines-0.2.1}/src/python_redlines/__about__.py

@@ -1,4 +1,4 @@
 # SPDX-FileCopyrightText: 2024-present U.N. Owen <void@some.where>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "0.2.0"
+__version__ = "0.2.1"

{python_redlines-0.2.0 → python_redlines-0.2.1}/src/python_redlines/engines.py

@@ -132,11 +132,11 @@ class BaseEngine(object):
         """
         return [self.extracted_binaries_path, author_tag, original_path, modified_path, target_path]
 
-    def run_redline(self, author_tag: str, original: Union[bytes, Path], modified: Union[bytes, Path], **kwargs) \
-            -> Tuple[bytes, Optional[str], Optional[str]]:
+    def run_redline(self, author_tag: str, original: Union[str, bytes, Path], modified: Union[str, bytes, Path],
+                    **kwargs) -> Tuple[bytes, Optional[str], Optional[str]]:
         """
-        Runs the redline binary. The 'original' and 'modified' arguments can be either bytes or file paths.
-        Returns the redline output as bytes.
+        Runs the redline binary. The 'original' and 'modified' arguments can be either bytes or file paths
+        (as ``str`` or ``pathlib.Path``). Returns the redline output as bytes.
 
         Additional keyword arguments are passed to _build_command() for engine-specific options.
         DocxodusEngine supports: detail_threshold, case_insensitive, detect_moves,