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

fix: typo in json digitization config #3960

Merged
merged 2 commits into from
Dec 9, 2024
Merged

Conversation

AJPfleger
Copy link
Contributor

@AJPfleger AJPfleger commented Dec 6, 2024

Summary by CodeRabbit

  • Bug Fixes

    • Corrected spelling errors in the spell-check ignore list.
    • Fixed a typo from "Digitial" to "Digital" in JSON serialization and deserialization functions, ensuring accurate representation of smearing configuration.
  • Chores

    • Updated internal documentation for spelling corrections.

@AJPfleger AJPfleger added this to the next milestone Dec 6, 2024
@AJPfleger AJPfleger requested a review from asalzburger December 6, 2024 09:38
Copy link

coderabbitai bot commented Dec 6, 2024

Walkthrough

A series of spelling corrections made, yes. In the CI/codespell_ignore.txt file, misspelled words removed, hmmm. Corrections also in smearing-config.py and JsonDigitizationConfig.cpp, yes. The term "Digitial" changed to "Digital," it was. JSON serialization and deserialization functions improved, they are. No alterations to exported entities, none.

Changes

File Path Change Summary
CI/codespell_ignore.txt Removed misspelled words: "bu," "strack," "compres," "coner," "dthe," "iself," "sortings," "gaus," "te," "parm," "writet," "localy," "lastr," "exprot," "pring," "aline," "boxs," "ans," "vart," "pixelx," "millepede," "dependees."
Examples/Algorithms/Digitization/scripts/smearing-config.py Corrected "Digitial" to "Digital" in block_to_json function.
Examples/Io/Json/src/JsonDigitizationConfig.cpp Corrected "Digitial" to "Digital" in to_json and from_json functions.

Poem

In code, a typo did dwell,
"Digitial" cast a spell.
Now "Digital" shines so bright,
Spelling fixed, all feels right!
With words corrected, we cheer,
For clarity, we hold dear! ✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 744466b and f110ddb.

📒 Files selected for processing (1)
  • CI/codespell_ignore.txt (0 hunks)
💤 Files with no reviewable changes (1)
  • CI/codespell_ignore.txt

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 Infrastructure Changes to build tools, continous integration, ... Component - Examples Affects the Examples module labels Dec 6, 2024
Copy link

github-actions bot commented Dec 6, 2024

📊: Physics performance monitoring for f110ddb

Full contents

physmon summary

Copy link
Member

@paulgessinger paulgessinger left a comment

Choose a reason for hiding this comment

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

If we read files that have the old string, is this an errors? I'm wondering what happens with ODD with this change? As long as we don't have a silent failure or other odd behavior, this should be ok.

Is this a breaking change?

Copy link
Contributor

@andiwand andiwand left a comment

Choose a reason for hiding this comment

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

I think we do not use Digital in any of our workflows. Since this is an Examples feature I think we can put this in without a breaking flag. This might break user workflows but should hopefully result in an error that explains the situation.

Copy link

sonarqubecloud bot commented Dec 9, 2024

@kodiakhq kodiakhq bot merged commit bd88be8 into acts-project:main Dec 9, 2024
43 checks passed
@github-actions github-actions bot removed the automerge label Dec 9, 2024
@AJPfleger AJPfleger deleted the digitial branch December 9, 2024 15:22
@paulgessinger paulgessinger modified the milestones: next, v38.2.0 Dec 16, 2024
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 Infrastructure Changes to build tools, continous integration, ...
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants