Skip to content

Fix typo in logger parameter: 'artifacts' → 'artifact' #1747

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Fix typo in logger parameter: 'artifacts' → 'artifact' #1747

wants to merge 1 commit into from

Conversation

jihan-chillin
Copy link
Contributor

@jihan-chillin jihan-chillin commented May 8, 2025 •
edited by qodo-merge-for-open-source bot
Loading

User description

This PR fixes a minor typo in a debug logging call to ensure the logger behaves as expected.

  • Fixed a typo in the get_logger().debug(...) call: changed artifacts= to artifact=.
  • The logger expects the parameter to be named artifact, and using the wrong keyword can cause logs to be silently ignored or raise runtime errors.
  • This fix ensures that debugging output is correctly captured and visible during development.

PR Type

enhancement

Description

  • Refactored and reformatted the pr_agent/tools/pr_description.py file.

    • Improved code readability with consistent indentation and line breaks.
    • Enhanced multi-line function calls and argument formatting.
    • Applied consistent string quoting and YAML key handling.

  • Standardized logger debug calls to use artifact= instead of artifacts=.

  • Improved error handling and logging for YAML parsing and file processing.

  • No functional logic changes; changes are for maintainability and clarity.

Changes walkthrough 📝

Relevant files
Enhancement
pr_description.py
Code formatting, logging, and readability improvements     

pr_agent/tools/pr_description.py

  • Reformatted code for consistent indentation and argument alignment.
  • Standardized logger debug calls to use artifact= parameter.
  • Enhanced error handling and logging for YAML and file processing.
  • Improved string handling and code comments for clarity.
    		• +455/-206
    Need help?
  • Type /help how to ... in the comments thread for any questions about Qodo Merge usage.
  • Check out the documentation for more information.
    •

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Reviewer Guide 🔍

    Here are some key observations to aid the review process:

    ⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
    🧪 No relevant tests
    🔒 No security concerns identified
    ⚡ Recommended focus areas for review

    Logger Parameter Fix

    The PR fixes a typo in the logger parameter name from 'artifacts=' to 'artifact=' to ensure debug logs are correctly captured.

     
    get_logger().debug("Relevant configs", artifact=relevant_configs)
if get_settings().config.publish_output and not get_settings().config.get(

    @qodo-merge-for-open-source Qodo Merge for Open Source
    Copy link
    Contributor

    PR Code Suggestions ✨

    Explore these optional code suggestions:

    CategorySuggestion                                                                                                                                    Impact
    Possible issue
    Fix parameter name typo

    The parameter name 'artifacts' is incorrect and should be 'artifact' to match
    the logger's expected parameter name. This typo could cause logging issues where
    the data isn't properly captured.

    pr_agent/tools/pr_description.py [133]

    -get_logger().debug("Relevant configs", artifacts=relevant_configs)
+get_logger().debug("Relevant configs", artifact=relevant_configs)
    • Apply / Chat
    Suggestion importance[1-10]: 8

    __

    Why: The suggestion correctly identifies a parameter name typo where artifacts is used instead of artifact in the logger call. This is a legitimate bug that could prevent proper logging of configuration data, as the logger expects the parameter to be named artifact. The fix is straightforward and important for ensuring proper logging functionality.

    		Medium
    • More
    • Author self-review: I have reviewed the PR code suggestions, and addressed the relevant ones.

    @mrT23
    Copy link
    Collaborator

    mrT23 commented May 8, 2025

    Avoid all the formatting issues for the PR to be merged.

    image

    Do only the typo fix.

    @jihan-chillin jihan-chillin mentioned this pull request May 9, 2025
    Merged
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers
    No reviews
    Assignees
    No one assigned
    Labels
    Review effort 1/5
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @jihan-chillin @mrT23