Skip to content

Back-port updated UsersGuide to maint/4.1.x#4636

Merged
casella merged 6 commits intomodelica:maint/4.1.xfrom
casella:maint/4.1.x
Apr 17, 2025
Merged

Back-port updated UsersGuide to maint/4.1.x#4636
casella merged 6 commits intomodelica:maint/4.1.xfrom
casella:maint/4.1.x

Conversation

@casella
Copy link
Copy Markdown
Contributor

@casella casella commented Apr 17, 2025

This commits back-ports to maint/4.1.x

It also provisionally updates the release dates of 4.1.0, will be updated again here and on the master branch when the library is officially released.

I checked how the documentation looks like in Dymola and OpenModelica with the code of this PR, all looks fine.

This PR was a bit problematic because of the structural changes of #4355 were applied to the master branch after branching off the ReleaseNotes_4.1.0 branch of #4327 more than one year ago and were never cherry-picked properly.

In order to avoid getting crazy with conflict resolution, I back-ported them manually, by adding the content of the Modelica/UsersGuide directory and replacing Modelica/package.mo with the files contained in the master branch.

This is the final PR before we tag RC.1, everything else is already in place. Please review ASAP so we can tag it today and avoid delaying the voting process further.

@casella casella added the V: 4.1.0-dev Issue originates in MSL v4.1.0-dev (and is not present in earlier releases) label Apr 17, 2025
@casella casella added this to the MSL4.1.0 milestone Apr 17, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 17, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


🪧 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
Copy Markdown
Contributor

@AHaumer AHaumer left a comment

Choose a reason for hiding this comment

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

LGTM
Thanks a lot to @casella and all colleagues working together to enable this release.
For the future we should discuss how to ease the process of generating the release notes.

Copy link
Copy Markdown
Contributor

@Esther-Devakirubai Esther-Devakirubai left a comment

Choose a reason for hiding this comment

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

Looks Good to me!
Thanks a lot @casella and team!!

@casella casella merged commit 0d6ec81 into modelica:maint/4.1.x Apr 17, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

3 participants