-
Notifications
You must be signed in to change notification settings - Fork 3
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
Add Machine and Operating Point Sections to Code and Documentation Files #344
base: develop
Are you sure you want to change the base?
Conversation
@wchan29 @noguchi-takahiro @elsevers Can one of you review this PR? |
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.
Thank you for updating the eMach documents, @dmnewman3. This looks useful. I personally prefer that the 2.2.1 Machine Class section outlines 1. Requirements to fully define machine
and 2. Code comments on user input
, which is similar manner as 2.2.2. If you accept this, could you consider to revise the article? I also want to propose some ideas below;
Co-authored-by: Takahiro <[email protected]>
Co-authored-by: Takahiro <[email protected]>
Co-authored-by: Takahiro <[email protected]>
Co-authored-by: Takahiro <[email protected]>
Thanks @noguchi-takahiro, I have implemented these and re-written the section in question. Please let me know what you think. |
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.
Thank you @dmnewman3. It looks good to me.
Level 1 review summary:
- Does the code run without error and produce the expected result? Not applicable
- Does the code comply with the code guidelines? Not applicable
- Does the code documentation comply with the documentation guidelines? Yes
- Is the writing, grammar, and syntax correct and clear? Yes
- Is the changeset compliant with the eMach architecture? Yes
- Does this review consider whether this physics are accurate? Not applicable
- Are the correct issues being closed (and are there no partially completed issues)? Yes
- Did the reviewer change the release schedule for the issues bing closed? Not applicable
- Did the reviewer change the branch the PR is being merged into? Not applicable
- Is PR approved to Level 2? Yes
Issue
Address issue #312
Summary
This PR does the following:
machine
andoperating point
sections todocumentation.rst
filemachine
andoperating point
sections tocode.rst
fileclose #312