Refactor, Documentation, and Code Cleanup #70
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Function already exists in parse_query.py
cyclotruc
reviewed
Dec 30, 2024
cyclotruc
approved these changes
Dec 30, 2024
Member
cyclotruc
left a comment
cyclotruc
left a comment
There was a problem hiding this comment.
Very good once again you're doing wonders to the codebase, thank you
FOLKS-Tech
pushed a commit
to FOLKS-Tech/gitingest
that referenced
this pull request
Sep 5, 2025
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR includes a combination of refactoring, documentation, and code cleanup tasks to improve the codebase's structure, readability, and maintainability. The changes include:
Refactoring:
_should_excludefunction iningest_from_query.py.clone.pyby moving theclone_repofunction to the top of the file, above helper functions.Documentation:
process_query.pyand thelogSliderToSizefunction inserver_utils.py.main.pywith docstrings and additional comments for clarity.Style:
async_timeoutfunction into its body for better placement.Chores:
markdownlintto pre-commit hooks for enforcing markdown standards and disabling the line-length rule.Fixes:
README.mdto remove inline HTML and add a top-level heading to comply with markdownlint rules.Code Cleanup:
normalize_patternfunction fromclient.py.These updates collectively improve the maintainability, readability, and consistency of the codebase, while also aligning with coding standards and best practices.