Open Issues Need Help
View All on GitHubAI Summary: This issue aims to enhance code documentation by adding comprehensive and consistent docstrings to all public methods. Currently, docstrings are incomplete, lack details like arguments and return values, and have inconsistent styles, which hinders contributor understanding, reduces IDE utility, and prevents auto-generated API documentation.
AI Summary: This issue proposes adding input validation for CLI arguments in the `scrape2md` tool. It addresses invalid inputs like negative values for `--max-pages` and `--delay`, and the lack of validation for the output directory path, which currently leads to confusing errors and unexpected behavior. The fix involves adding checks after argument parsing to ensure valid input ranges.
AI Summary: The project's file operations, specifically `open()`, do not explicitly specify the character encoding, relying instead on platform defaults. This can lead to `UnicodeDecodeError` and inconsistent behavior, particularly on Windows when handling UTF-8 encoded files. The proposed fix is to add `encoding='utf-8'` to all relevant file opening calls to ensure consistent and correct handling.
AI Summary: This GitHub issue proposes refactoring hardcoded "magic numbers" found throughout the codebase into named constants. Examples include values like `200`, `3`, `100`, and `0.8`, which currently lack clear meaning and impact maintainability. The suggested fix involves extracting these values into descriptive class constants to improve code readability and clarify their rationale.
AI Summary: This issue proposes adding a `CONTRIBUTING.md` file to provide essential development guidelines for contributors. Currently, there's a lack of documented processes for development setup, coding standards, and running tests, leading to inconsistent contributions. The new file aims to clarify these processes, including development setup, code style, testing instructions, and the pull request workflow.
AI Summary: This issue proposes adding a `CHANGELOG.md` file to the repository to track version history and changes. The absence of this file makes it difficult for users to understand updates and deviates from standard Python packaging practices. The suggested fix involves creating the file and adhering to the "Keep a Changelog" format.
AI Summary: This GitHub issue requests the addition of a standard `--version` or `-V` flag to the CLI. The flag should display the installed package version, as its absence makes it difficult for users to identify their current version and debug issues. A specific Python `argparse` code snippet is provided as a direct solution.