Skip to content

Fix spelling #4505

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix spelling #4505

wants to merge 2 commits into from

Conversation

beutlich
Copy link
Member

@beutlich beutlich commented Nov 17, 2024

Follow-up of #4493.

As reported by https://github.com/modelica/ModelicaStandardLibrary/actions/runs/11875525138/job/33092839921

Summary by CodeRabbit

  • Bug Fixes

    • Corrected a spelling mistake in an assertion message within the test utilities.
  • Chores

    • Updated automated workflow spelling checks to include and properly handle the relevant file.

@beutlich beutlich added L: Utilities Issue addresses Modelica.Utilities V: 4.2.0-dev Issue originates in MSL v4.2.0-dev (and is not present in earlier releases) labels Nov 17, 2024
@beutlich beutlich added this to the MSL4.2.0 milestone Nov 17, 2024
@beutlich beutlich added the CI Issue that addresses continuous integration label Dec 28, 2024
@beutlich beutlich enabled auto-merge (squash) January 15, 2025 20:01
@beutlich beutlich requested review from casella and AHaumer January 15, 2025 20:01
Copy link

coderabbitai bot commented Apr 22, 2025

Walkthrough

The changes consist of a spelling correction in an assertion message within the ModelicaTest.Utilities package, updating "occurences" to "occurrences". Additionally, the GitHub Actions workflow configuration was updated to ensure the spelling check covers the corrected file by adjusting the codespell command options and skip lists. No changes were made to any logic, control flow, or public interfaces.

Changes

File(s) Change Summary
ModelicaTest/Utilities.mo Corrected a spelling mistake in an assertion message ("occurences" to "occurrences").
.github/workflows/checkCron.yml Updated codespell options and skip lists to include ModelicaTest/Utilities.mo.

Poem

In the warren where the code does dwell,
A typo hopped in, but now all is well!
"Occurrences" spelled right,
The tests are a delight,
With workflows checked, our carrots we smell! 🥕


🪧 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 generate docstrings to generate docstrings for this 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.

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

🧹 Nitpick comments (1)
.github/workflows/checkCron.yml (1)

81-81: Skip Utilities.mo in the bulk spelling run
Including ./ModelicaTest/Utilities.mo in the final --skip list prevents duplicate errors after your targeted check. Functionally this is sound. Consider an optional cleanup: move the long comma‑separated skip list into a dedicated file (e.g. .codespellskip) and reference it via --skip-file to improve maintainability.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2d5dea3 and cf42864.

📒 Files selected for processing (2)
  • .github/workflows/checkCron.yml (1 hunks)
  • ModelicaTest/Utilities.mo (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: external_c_checks_cmake_windows-msvc
  • GitHub Check: external_c_checks_cmake_windows-cygwin
🔇 Additional comments (2)
.github/workflows/checkCron.yml (1)

79-79: Enable spelling check for Utilities.mo
The new codespell -L fo ./ModelicaTest/Utilities.mo invocation correctly brings your updated test file into the spelling pipeline so the “occurrences” fix is verified.

ModelicaTest/Utilities.mo (1)

220-220:

✅ Verification successful

Correct spelling in assertion message
The change from “occurences” to “occurrences” in the Strings.contains 2 failed (multiple occurrences) message is accurate and aligns with English spelling. Please verify that no other instances of the old typo remain across the repo:


🏁 Script executed:

#!/bin/bash
# Search for any leftover "occurences" typos
rg -n "occurences" .

Length of output: 20


All instances of “occurences” have been removed
I ran rg -n "occurences" . across the repository and found no remaining typos. The spelling correction in ModelicaTest/Utilities.mo is complete.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Issue that addresses continuous integration L: Utilities Issue addresses Modelica.Utilities V: 4.2.0-dev Issue originates in MSL v4.2.0-dev (and is not present in earlier releases)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant