Skip to content

Conversation

@filipchristiansen
Copy link
Contributor

@filipchristiansen filipchristiansen commented Dec 30, 2024

This PR introduces two main changes:

  1. Adds docstrings to various functions to improve code documentation and readability.
  2. Moves the main function process_query to the top of the process_query.py file for better organization.
  3. Prefixes helper functions with an underscore to follow Python naming conventions for internal functions.
  4. Moves the AsyncTimeoutError exception to the gitingest.exceptions module for better exception handling organization.

These changes enhance code clarity, maintainability, and adhere to best practices in Python code organization and exception management.

@filipchristiansen filipchristiansen changed the title Add docstrings and refactor: Move AsyncTimeoutError to gitingest.exceptions Add docstrings, refactor process_query, and move AsyncTimeoutError to gitingest.exceptions Dec 30, 2024
Copy link
Member

@cyclotruc cyclotruc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you, the new docstrings are very much welcome

@cyclotruc cyclotruc merged commit fab90a6 into coderamp-labs:main Dec 30, 2024
12 checks passed
@filipchristiansen filipchristiansen deleted the add-docstrings-move-AsyncTimeoutError branch December 30, 2024 11:21
FOLKS-Tech pushed a commit to FOLKS-Tech/gitingest that referenced this pull request Sep 5, 2025
… gitingest.exceptions (coderamp-labs#77) * refactor: prefix helper functions with an underscore * Add docstrings to functions and move AsyncTimeoutError to gitingest.exceptions * Refactor: Move process_query to top and prefix helper functions with an underscore
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

2 participants