Refactor, Documentation, and Code Cleanup (#70)

Code Quality:
- Add markdownlint to pre-commit hooks for consistent markdown formatting
- Add missing type hints to constants and variables
- Prefix helper functions with underscore for better encapsulation

Documentation:
- Update README.md to follow markdown best practices
- Add docstrings to functions in process_query.py, server_utils.py and main.py

Refactoring:
- Remove redundant normalize_pattern function from client.py
- Simplify logic in should_exclude function in ingest_from_query.py
- Improve code organization in clone.py
- Move async_timeout comment into function body for better context
This commit is contained in:
Filip Christiansen 2024-12-30 02:53:17 +01:00 committed by GitHub
parent 65b4b4a589
commit 4e5c9521e8
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 333 additions and 215 deletions

View file

@ -76,3 +76,10 @@ repos:
rev: v1.36.4
hooks:
- id: djlint-reformat-jinja
- repo: https://github.com/igorshubovych/markdownlint-cli
rev: v0.43.0
hooks:
- id: markdownlint
description: "Lint markdown files."
args: ["--disable=line-length"]