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
[ci skip] Update Documentation - Pyiron release chapter #609
Conversation
@niklassiemer While going through the workflows I noticed that some of the comments inside appear to be outdated as well. E.g.
I'm currently writing a short descripition for each of these workflows and am thinking about changing these comments with a new short sentence about what the workflow actually does. Should I open a new issue for this (and or create a new PR) or should I just do this within the current PR (seems a bit bad practice). |
You are absolutely right. The comments are from a first version of these GitHub workflows and are quite outdated. I think we started with a unittest workflow (for which the sentence is ok) and copied the workflow without changing the description. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks a lot for updating this! I found quite some stuff where our previous documentation was to bad to get what is actually going on...
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
Ok i keep it here so it is simpler |
I will add the last missing workflows until the end of this week, add the first lines of each of these to the corresponding workflow and then change the PR from draft to actual PR for final review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I made a few corrections, but otherwise LGTM.
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
One typo and then this is good to go :) Thanks!
Co-authored-by: Niklas Siemer <70580458+niklassiemer@users.noreply.github.com>
Relates to issue #599 and #590.
This PR is still work in progress, please feel free to add things and/or comment on things that might feel unclear.
What I changed:
What I still want to do: