Skip to content

comments refactoring and added annotations where needed#22

Merged
kernelism merged 1 commit intomasterfrom
comments-and-annotations
May 23, 2025
Merged

comments refactoring and added annotations where needed#22
kernelism merged 1 commit intomasterfrom
comments-and-annotations

Conversation

@kernelism
Copy link
Collaborator

In this initial step, I have only made the following changes:

  1. I had added function description comments in the same format across file where it was missing. This includes a one liner description, args and return/raises/yield info.
  2. Added type annotations where it was missing
  3. I have removed some redundant comments here and there.
  4. Have not touched the files which were taken from other libraries, like mdconvert.py.

@kernelism kernelism requested a review from Copilot May 23, 2025 07:56
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR standardizes and refactors inline comments and docstrings across multiple modules while adding missing type annotations. The key changes include uniform docstring formatting with detailed argument and return descriptions, removal of redundant comments, and expanded type annotations in functions and methods.

Reviewed Changes

Copilot reviewed 22 out of 22 changed files in this pull request and generated no comments.

Show a summary per file
File Description
mxtoai/tools/mock_jina_service.py Standardized docstring formatting and added detailed docstrings for functions.
mxtoai/tools/fallback_search_tool.py Added docstrings with consistent argument and return descriptions.
mxtoai/tools/attachment_processing_tool.py Improved documentation and added type annotations in constructors and methods.
mxtoai/tasks.py Added detailed docstrings and type hints to utility functions.
mxtoai/scripts/*.py Updated docstrings and added missing type annotations to functions handling image/text processing and file inspection.
mxtoai/scripts/report_formatter.py, gaia_scorer.py, citation_tools.py Refactored docstrings for clarity and consistency.
mxtoai/email_sender.py, api.py, email_handles.py, dependencies.py Enhanced documentation for email processing and API responses.
mxtoai/agents/email_agent.py and mxtoai/_logging.py Added detailed docstrings covering all parameters and return types.
mxtoai/prompts/*.py Modernized multi-line string formatting in template files.

@kernelism kernelism merged commit 958d0b1 into master May 23, 2025
1 of 2 checks passed
@BhaveshKukreja29 BhaveshKukreja29 deleted the comments-and-annotations branch January 12, 2026 05:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants