From 85262c38a103ab245d7ceb856d9d78b3ec9c7e8c Mon Sep 17 00:00:00 2001 From: Adam Fourney Date: Wed, 12 Mar 2025 11:05:46 -0700 Subject: [PATCH] Added docs as to when to use misc tests. --- packages/markitdown/tests/test_cli_misc.py | 3 +++ packages/markitdown/tests/test_module_misc.py | 4 ++++ 2 files changed, 7 insertions(+) diff --git a/packages/markitdown/tests/test_cli_misc.py b/packages/markitdown/tests/test_cli_misc.py index d301654..345d5cc 100644 --- a/packages/markitdown/tests/test_cli_misc.py +++ b/packages/markitdown/tests/test_cli_misc.py @@ -3,6 +3,9 @@ import subprocess import pytest from markitdown import __version__ +# This file contains CLI tests that are not directly tested by the FileTestVectors. +# This includes things like help messages, version numbers, and invalid flags. + def test_version() -> None: result = subprocess.run( diff --git a/packages/markitdown/tests/test_module_misc.py b/packages/markitdown/tests/test_module_misc.py index 2a2c3ab..4079107 100644 --- a/packages/markitdown/tests/test_module_misc.py +++ b/packages/markitdown/tests/test_module_misc.py @@ -12,6 +12,10 @@ from markitdown import ( StreamInfo, ) +# This file contains module tests that are not directly tested by the FileTestVectors. +# This includes things like helper functions and runtime conversion options +# (e.g., LLM clients, exiftool path, transcription services, etc.) + skip_remote = ( True if os.environ.get("GITHUB_ACTIONS") else False ) # Don't run these tests in CI