Skip to content

Conversation

@AHaumer
Copy link
Contributor

@AHaumer AHaumer commented Apr 11, 2025

Added obsolete annotation (fixes #4609)
Once reviews are done and the PR is merged: @Esther-Devakirubai please backport to 4.1.x!

Summary by CodeRabbit

  • Documentation
    • Updated deprecation messages for several legacy electrical line components, advising users to transition to the new, recommended alternative.

@coderabbitai
Copy link

coderabbitai bot commented Apr 11, 2025

Walkthrough

The pull request updates the annotations in the TLine1, TLine2, and TLine3 model files within the Modelica/Electrical/Analog/Lines directory. Each model’s annotation now includes an obsolete attribute with a message advising users to use Modelica.Electrical.Analog.Lines.TLine instead while retaining the original defaultComponentName.

Changes

File(s) Change Summary
Modelica/Electrical/Analog/Lines/TLine{1,2,3}.mo Modified the annotation block to add an obsolete attribute with the message: "Please use Modelica.Electrical.Analog.Lines.TLine instead of this model".

Assessment against linked issues

Objective Addressed Explanation
Add obsolete annotation for TLine1, TLine2, TLine3 (#4609)

Poem

I'm a hopping rabbit, delighted and keen,
Updating TLine models with a shiny new sheen.
Obsolete messages now guide the way,
Leading to a brighter modeling day.
With each tiny change, I cheer—🐇✨ hooray!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)
  • We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 992b770 and 6c6267d.

📒 Files selected for processing (3)
  • Modelica/Electrical/Analog/Lines/TLine1.mo (1 hunks)
  • Modelica/Electrical/Analog/Lines/TLine2.mo (1 hunks)
  • Modelica/Electrical/Analog/Lines/TLine3.mo (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • Modelica/Electrical/Analog/Lines/TLine1.mo
  • Modelica/Electrical/Analog/Lines/TLine3.mo
  • Modelica/Electrical/Analog/Lines/TLine2.mo
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: external_c_checks_cmake_windows-cygwin

🪧 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 plan to trigger planning for file edits and PR creation.
  • @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.

@AHaumer AHaumer added the L: Electrical.Analog Issue addresses Modelica.Electrical.Analog label Apr 11, 2025
@AHaumer AHaumer added this to the MSL4.1.0 milestone Apr 11, 2025
@AHaumer AHaumer enabled auto-merge April 11, 2025 16:57
Copy link
Contributor

@casella casella left a comment

Choose a reason for hiding this comment

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

@AHaumer, the correct path is Modelica.Electrical.Analog.Lines.TLine. Please fix in all three files

@AHaumer AHaumer requested a review from casella April 12, 2025 06:46
@AHaumer
Copy link
Contributor Author

AHaumer commented Apr 12, 2025

@AHaumer, the correct path is Modelica.Electrical.Analog.Lines.TLine. Please fix in all three files

@casella sorry for the mistake - done.

@beutlich beutlich added the V: 4.1.0-dev Issue originates in MSL v4.1.0-dev (and is not present in earlier releases) label Apr 13, 2025
@beutlich beutlich disabled auto-merge April 13, 2025 15:53
@beutlich beutlich enabled auto-merge (squash) April 13, 2025 15:54
@beutlich beutlich merged commit 1353d2c into modelica:master Apr 14, 2025
3 checks passed
casella pushed a commit to casella/ModelicaStandardLibrary that referenced this pull request Apr 14, 2025
casella pushed a commit to casella/ModelicaStandardLibrary that referenced this pull request Apr 14, 2025
@beutlich beutlich removed the request for review from christiankral April 15, 2025 04:48
@beutlich beutlich modified the milestones: MSL4.1.0, maintenance Apr 15, 2025
@AHaumer AHaumer deleted the ObsoleteLineModels branch April 19, 2025 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

L: Electrical.Analog Issue addresses Modelica.Electrical.Analog V: 4.1.0-dev Issue originates in MSL v4.1.0-dev (and is not present in earlier releases)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Missing obsolete-annotation for Modelica.Electrical.Analog.Lines.{TLine1, TLine2, TLine3}

3 participants