Skip to content
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.

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

chore: replace some couts with logger #3912

Merged
merged 2 commits into from
Nov 27, 2024
Merged

Conversation

AJPfleger
Copy link
Contributor

@AJPfleger AJPfleger commented Nov 27, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Improved logging consistency by replacing standard output with structured logging mechanisms across multiple classes.
    • Corrected minor typographical errors in comments for clarity.
  • Documentation

    • Enhanced comment clarity and formatting for better readability in the codebase.

Copy link

coderabbitai bot commented Nov 27, 2024

Walkthrough

Changes made to the MuonHoughSeeder.cpp, EDM4hepReader.cpp, and RootMaterialTrackReader.cpp files enhance code clarity and standardize logging practices. Modifications include refining comments, correcting typographical errors, and replacing std::cout statements with the ACTS_VERBOSE or ACTS_DEBUG macros. The overall functionality and control flow of the classes remain unchanged, focusing on improving readability and consistency in logging without altering any logic.

Changes

File Path Change Summary
Examples/Algorithms/TrackFinding/src/MuonHoughSeeder.cpp Adjusted comments for clarity, corrected typos, and standardized logging to ACTS_VERBOSE.
Examples/Io/EDM4hep/src/EDM4hepReader.cpp Replaced std::cout with ACTS_DEBUG for logging, adjusted sim hits handling, and improved clarity.
Examples/Io/Root/src/RootMaterialTrackReader.cpp Removed std::cout for total entries, replaced with ACTS_DEBUG, maintaining existing logic.

Possibly related PRs

Suggested labels

Component - Examples, automerge

In code we trust, clarity we seek,
With comments refined, and logging unique.
From std::cout to macros we glide,
A structured approach, our source code's pride.
Enhancements made, yet logic stays true,
In the galaxy of code, we shine anew! 🌌✨


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@AJPfleger AJPfleger added this to the next milestone Nov 27, 2024
@github-actions github-actions bot added Component - Examples Affects the Examples module Track Finding labels Nov 27, 2024
Copy link

github-actions bot commented Nov 27, 2024

📊: Physics performance monitoring for 157f982

Full contents

physmon summary

Copy link

sonarcloud bot commented Nov 27, 2024

@kodiakhq kodiakhq bot merged commit 98acf90 into acts-project:main Nov 27, 2024
44 checks passed
@AJPfleger AJPfleger deleted the cout branch November 27, 2024 16:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Examples Affects the Examples module Track Finding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants