-
Notifications
You must be signed in to change notification settings - Fork 169
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
Edit Modelica.UsersGuide.ReleaseNotes.Version_4_1_0 #4260
Comments
@beutlich @casella just for clarification and understanding .
ResolvedGitHubIssues.md
|
Well, as you like. In my opinion it can be easily scheduled after v4.1.0 is released since we have a working solution right now: https://github.com/modelica/ModelicaStandardLibrary/actions/workflows/generateReleaseNotes.yml -> Run workflow (w/ or w/o watermark).
There are five tables:
Each table has the same layout, that you can copy if not yet done.
Editing release notes usually is manual work. Probably AI can be of help nowadays.
Editing release notes used to be manual work. The MAP-Lib project leader and library officers need to decide which of the many changes is worth and relevant for the MSL end user (aka simulation engineer). Of course the input of
|
Given the MSL library comparison of #4300 I see the following classes (besides the ones already documented) that should appear in the release notes (to the best of my knowledge).
Of course, the library comparison only lists the changed class. If there are classes that use a changed class as component (and thus are also affected by the change) it should be ideally mentioned. The library officers shall advice here. I did not check for tables 2 and 3. |
@beutlich in the previous message what did you mean by "besides the ones already documented" we are only going to document it right , so the new Release note only contains the ones mentioned above plus what we add along , and is there a way I could easily figure out the content for other tables ? |
@HansOlsson @beutlich @maltelenz @MartinOtter I have created a branch to work on the release notes ,have been adding things based on the information from above messages and would like to inform all the Library officers to look into it and contribute so do we have a way to do that other than Tagging everyone here . |
@AHaumer @MartinOtter @christiankral @HansOlsson @tobolar @casella , I have created a branch to work on the release notes and added things from the above list , the exact change associated with each is added as the corresponding ticket heading and needs to edited at some places , but I would like to get input from other library officers on the content to added for other tables , and the existing one can be seen as a draft to build upon . |
Can you create a draft PR from this branch. Would make life easier for reviewers. |
I'm not sure how shall I proceed. Shall we contribute to that branch? Or just to comment on it - then please consider #4260 (comment) |
@tobolar @beutlich #4327 is created for issue. and from my understanding it is desired to edit the release notes.html files (Modelica/Resources/ReleaseNotes/Modelica.UsersGuide.ReleaseNotes.Version_4_1_0.html) directly .The other edited files starting with "Resolvedgithubissues...." are autogenerated and also needs update as new PR is closed but can be easily generated with the script . |
For the next release we should consider splitting Modelica.mo into single files (to enable easier handling of release notes) |
Just to not forget about it:
The tables in Modelica.UsersGuide.ReleaseNotes.Version_4_1_0 for
need to be (manually) edited before a final release of MSL v4.1.0
#4251 can be considered as a start here.
The text was updated successfully, but these errors were encountered: