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(physmon): make configuration of all the fitters the same #3916

Merged
merged 1 commit into from
Nov 28, 2024

Conversation

AJPfleger
Copy link
Contributor

@AJPfleger AJPfleger commented Nov 27, 2024

Popped up in a discussion in #3889 that the configurations should be the same for all fitters.

Summary by CodeRabbit

  • Chores
    • Updated parameter naming in function calls for improved clarity and readability.

@AJPfleger AJPfleger added this to the next milestone Nov 27, 2024
Copy link

coderabbitai bot commented Nov 27, 2024

Walkthrough

Modify the function call to runTruthTrackingGsf, it does. Parameters passed explicitly, now they are. Clarity in code, this change brings. The structure and logic, unchanged they remain. The same functionality preserved, yes.

Changes

File Path Change Summary
CI/physmon/workflows/physmon_trackfitting_gsf.py Updated function call to runTruthTrackingGsf with explicit parameter names for clarity.

Poem

In code where clarity shines bright,
Parameters named, a joyous sight.
With every change, the flow stays true,
A dance of logic, old yet new.
Readable paths, like stars in the night! 🌟


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.

@github-actions github-actions bot added the Infrastructure Changes to build tools, continous integration, ... label Nov 27, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
CI/physmon/workflows/physmon_trackfitting_gsf.py (1)

23-25: Clarity in the Force, I sense!

Explicit parameter names, you now use. Wisdom in this change, there is. Easier to read and maintain, the code becomes. The way of the Jedi, this follows - clear and purposeful.

Consider this path to even greater clarity, you should:

    runTruthTrackingGsf(
-        trackingGeometry=setup.trackingGeometry,
-        field=setup.field,
-        digiConfigFile=setup.digiConfig,
+        trackingGeometry=setup.trackingGeometry,  # Geometry for track fitting
+        field=setup.field,                        # Magnetic field configuration
+        digiConfigFile=setup.digiConfig,          # Digitization settings
        outputDir=tp,
        s=s,
    )

Comments to guide future padawans, these would provide. Optional but helpful, they are.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 217ad15 and b9b26b0.

📒 Files selected for processing (1)
  • CI/physmon/workflows/physmon_trackfitting_gsf.py (1 hunks)

Copy link

📊: Physics performance monitoring for b9b26b0

Full contents

physmon summary

@paulgessinger paulgessinger modified the milestones: next, v38.0.0 Nov 28, 2024
@kodiakhq kodiakhq bot merged commit e10cd54 into acts-project:main Nov 28, 2024
52 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaks Athena build This PR breaks the Athena build Fails Athena tests This PR causes a failure in the Athena tests Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants