Update list of resolved GH issues for v4.1.0-rc.1 #4590
Conversation
beutlich
added
the
L: Resources
beutlich
force-pushed
the
update-resolved-GH-issues
branch
from
99f7c2b to
9cb55cb
Compare
|
@beutlich, @nithish-selvan will take care of this tomorrow morning in the context of 4327. |
Yes, as long as the official script / GitHub Action is used, it is fine for me. |
beutlich
force-pushed
the
update-resolved-GH-issues
branch
from
9cb55cb to
196a88a
Compare
WalkthroughThe updates focus on documentation for the Modelica Standard Library version 4.1.0, specifically enhancing the release notes and resolved issues listings. The number of closed issues and pull requests has been increased to reflect recent maintenance and improvements. Additional entries detail bug fixes, enhancements, documentation clarifications, new examples, and miscellaneous updates across various library sections. No changes have been made to code, APIs, or public entity declarations; the modifications are strictly to documentation files summarizing the scope of the latest release. Changes
Suggested labels
Suggested reviewers
Poem
🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
beutlich
changed the title
I updated this PR anyway. |
beutlich
force-pushed
the
update-resolved-GH-issues
branch
from
196a88a to
2448d49
Compare
beutlich
force-pushed
the
update-resolved-GH-issues
branch
from
2448d49 to
d8450f7
Compare
|
@nithish-selvan I updated and rebased again. |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.pdfis excluded by!**/*.pdf
📒 Files selected for processing (3)
Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.html(39 hunks)Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.md(41 hunks)Modelica/UsersGuide/ReleaseNotes.mo(1 hunks)
🚧 Files skipped from review as they are similar to previous changes (2)
- Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.md
- Modelica/UsersGuide/ReleaseNotes.mo
🔇 Additional comments (50)
Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.html (50)
18-18: Verify updated issue count and PR count.The text now reads “554 issues (including 387 pull requests (PR)) were closed.” Please confirm these numbers match the milestone on GitHub and that the corresponding counts are also updated in the markdown (
ResolvedGitHubIssues.md) and UsersGuide release notes (ReleaseNotes.mo).
28-28: Entry for issue #4382 is correctly formatted.The new issue link uses
/issues/and omits the(PR)tag, in line with other issue entries.
32-32: Issue #3567 entry is properly formatted.Follows the style for issue listings.
54-54: Pull request #4247 entry is correctly formatted.Includes
(PR)tag and valid/pull/link.
55-55: Pull request #4357 entry follows expected format.
56-56: Pull request #4434 entry is well-formatted.
57-57: Pull request #4624 entry is correctly formatted.
58-58: Pull request #4630 entry is consistent with formatting.
67-67: Pull request #4345 entry is properly formatted.
78-78: Pull request #3985 entry matches style conventions.
82-82: Pull request #4066 entry is correctly formatted.
89-90: Block examples entries #4094 and #4433 are formatted correctly.Both PR entries include
(PR)and valid links under the Examples section.
114-114: Issue #4414 entry is formatted in line with other miscellaneous items.
129-129: Issue #4301 under C‑Sources is formatted correctly.
151-151: Pull request #3861 entry correctly includes(PR)tag.
156-160: Miscellaneous C‑Sources entries (#4281, #4487, #4489, #4530, #4531) maintain consistency.PRs use
/pull/and(PR); issues use/issues/with no tag.
163-165: New Clocked examples section and entry are well‑structured.
167-169: Clocked documentation section header and entry follow established pattern.
203-203: Pull request #4452 entry under Complex is correctly added.*
230-230: Pull request #3926 entry under Electrical.Analog enhancements is formatted properly.
234-234: Pull request #3590 entry under Electrical.Analog examples is correctly formatted.
242-242: Issue #4558 entry under Electrical.Analog examples is formatted as an issue.
282-282: Issue #4402 under Electrical.Machines bugs is correctly formatted.
283-283: Pull request #4444 entry under Electrical.Machines bugs is properly formatted.
295-298: Electrical.Machines example entries (#4363, #4565, #4579, #4582) are consistently formatted.
313-313: Issue #4517 under Electrical.Machines miscellaneous follows standard formatting.
320-321: Electrical.Polyphase entries (#4402 issue, #4444 PR) are correctly listed.
336-338: PowerConverters examples section header and entry (#3523) are properly structured.
356-356: Pull request #4022 under Electrical.QuasiStatic bugs is formatted correctly.
366-368: Electrical.QuasiStatic examples section and entry (#4356) follow the same HTML structure.
399-400: Fluid bug entries (#3959 PR, #4128 issue) are correctly formatted.
405-406: Fluid bug entries (#4526 issue, #4545 PR) maintain consistency.
417-417: Fluid example entry #4033 is properly formatted as a PR.
425-425: Fluid documentation entry #4435 is correctly formatted with(PR).
429-429: Fluid miscellaneous issue #3628 is consistent with other issue listings.
435-437: Fluid miscellaneous PR entries (#4469, #4533, #4568) follow proper conventions.
440-443: Fluid.Dissipation header and bug entries (#4552 issue, #4580 PR) are formatted appropriately.
456-458: Icons documentation entry #4628 and section structure are correct.
469-470: Magnetic.FluxTubes entries (#4537 issue, #4567 PR) maintain consistency.
502-502: Magnetic.FundamentalWave bug entry #3817 is correctly formatted.
508-508: Magnetic.FundamentalWave example entry #4570 is formatted properly as a PR.
512-512: Magnetic.FundamentalWave documentation entry #4616 follows the(PR)convention.
587-587: Mechanics.MultiBody PR entry #3724 is correctly formatted.
624-624: Mechanics.MultiBody miscellaneous issue #3707 is formatted as other issues.
700-700: Media bug PR entry #3704 is correctly formatted.
703-706: Media bug entries (#4389, #4428, #4512 issues) and PR #4546 are consistently formatted.
731-731: Media miscellaneous issue #4232 formatting is correct.
900-903: UsersGuide documentation entries (#4251, #4435, #4501, #4628) are properly listed under UsersGuide.
819-821: Potential duplication of PR #4251 across Resources and UsersGuide sections.The same PR appears under both Resources documentation and UsersGuide documentation; please verify if both entries are needed or if one should be removed.
835-840: Resources miscellaneous entries (#4316, #4322, #4349, #4371, #4463, #4487) are consistently formatted.However, PR #4487 also appears under C‑Sources miscellaneous; please confirm if cross‑listing is intentional.
Modelica/Resources/Documentation/Version-4.1.0/ResolvedGitHubIssues.html
Show resolved
Hide resolved
|
@beutlich thanks! could you please advise me with taking this ticket #4590 forward? I see that #4327 also includes GH files. If we merge this ticket to master, then when #4327 would override the updates. I am relatively new to Github. if also possible, can you help with generating |
* Add redacted release notes for v4.1.0
* fixed ResolvedGitHubIssues
* Added content for OpenTank
* Enhanced description for pd_pTX_der and dofpT
* applied suggestion from Beutlich
* Latest version of ResolvedGitHubIssues added
* Updated the no. of issues and PRs
* Improved description of Spring non-backwards compatibility
* Better specified what we mean by non-backwards compatible, to avoid scaring users unnecessarily
* Fixed typo
* Added description of Modelica.Electrical.Machines.Utilities.RotationalCoupling
* Moved SVPWM from non-backwards compatible to critical error fixed category
* Moved improvement to description of non-compatible changes to 4.1.0
* Re-ordered table in alphabetical order
* Moved change in M400_50A parameter value to critical fixes.
* Added critical fix for dp_volumeFlowRate_MFLOW and VolumeFlowRate
* Added section on obsolete models to 4.1.0 release notes
* Added Modelica.Blocks.Routing.Extractor to list of non-backward compatible models in the 4.1.0 release notes
* Added change of Modelica.Constants.{inf,eps,small} to the 4.1.0 release notes
* Removed <p></p> tags from tables
* Fixed html syntax error
* Fixed proper <code> tag instead of font specifier
* Added list of tested libraries
* Removed old list of libraries
* Added a note on tools
* Added ThermofluidStream to the list of tested libraries
* Updated text about the fix of R134a_ph dofpT()
* Fixed list of tested libraries, by @HansOlsson
Co-authored-by: Hans Olsson <[email protected]>
* Updated ResolvedGitHubIssues
* Update list of resolved GH issues for MSL 4.1.0 (#4590)
* Removed bogus Version_4_1_0.html file. Will add updated one to the final release
---------
Co-authored-by: Thomas Beutlich <[email protected]>
Co-authored-by: Esther-Devakirubai <[email protected]>
Co-authored-by: Francesco Casella <[email protected]>
Co-authored-by: Hans Olsson <[email protected]>
Generated by Modelica/Resources/Documentation/Generate-ReleaseNotes.py via GHA run https://github.com/modelica/ModelicaStandardLibrary/actions/runs/13797605068
Follow-up of #4251.
Summary by CodeRabbit