txt2ebook 0.1.129__tar.gz → 0.1.130__tar.gz

{txt2ebook-0.1.129 → txt2ebook-0.1.130}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: txt2ebook
-Version: 0.1.129
+Version: 0.1.130
 Summary: CLI tool to convert txt file to ebook format
 Home-page: https://github.com/kianmeng/txt2ebook
 License: AGPL-3.0-or-later

{txt2ebook-0.1.129 → txt2ebook-0.1.130}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "txt2ebook"
-version = "0.1.129"
+version = "0.1.130"
 description = "CLI tool to convert txt file to ebook format"
 authors = ["Kian-Meng Ang <kianmeng@cpan.org>"]
 license = "AGPL-3.0-or-later"

{txt2ebook-0.1.129 → txt2ebook-0.1.130}/src/txt2ebook/__init__.py

@@ -28,34 +28,34 @@ __version__ = "0.1.126"
 
 
 def setup_logger(config: argparse.Namespace) -> None:
-    """Sets up logging configuration based on command-line arguments.
+    """Configures logging based on command-line arguments.
 
     Args:
-        config (argparse.Namespace): Namespace containing parsed arguments.
+        config: Namespace containing parsed arguments.
     """
     if config.quiet:
         logging.disable(logging.NOTSET)
         return
 
-    level = logging.DEBUG if config.debug else logging.INFO
-    format_string = (
+    log_level = logging.DEBUG if config.debug else logging.INFO
+    log_format = (
         "%(levelname)5s: %(message)s" if config.debug else "%(message)s"
     )
 
     logging.basicConfig(
-        level=level,
-        format=format_string,
+        level=log_level,
+        format=log_format,
         stream=sys.stdout,
         datefmt="%Y-%m-%d %H:%M:%S",
     )
 
 
-def log_or_raise_on_warning(msg: str, raise_on_warning: bool = False) -> None:
-    """Log warnings or raise it as exception.
+def log_or_raise_on_warning(message: str, raise_on_warning: bool = False) -> None:
+    """Logs a warning message or raises an exception.
 
     Args:
-        msg(str): Warning message.
-        raise_on_warning(bool): To raise exception instead of logging.
+        message: The warning message to log or raise.
+        raise_on_warning: If True, raises a RuntimeError instead of logging.
     """
     if raise_on_warning:
         raise RuntimeError(msg)
@@ -75,7 +75,15 @@ def print_env() -> None:
 
 
 def detect_and_expect_language(content: str, config_language: str) -> str:
-    """Detect and expect the language of the txt content."""
+    """Detects the content language and compares it to the configured language.
+
+    Args:
+        content: The text content to analyze.
+        config_language: The language specified in the configuration.
+
+    Returns:
+        The configured language, or the detected language if none is configured.
+"""
     detect_language = langdetect.detect(content)
     config_language = config_language or detect_language
     logger.info("Config language: %s", config_language)

{txt2ebook-0.1.129 → txt2ebook-0.1.130}/src/txt2ebook/exceptions.py

@@ -17,4 +17,4 @@
 
 
 class EmptyFileError(Exception):
-    """Empty file content in txt file."""
+    """Raised when the input file has no content."""