Add Machine and Operating Point Sections to Code and Documentation Files#344
Add Machine and Operating Point Sections to Code and Documentation Files#344
Conversation
|
@wchan29 @noguchi-takahiro @elsevers Can one of you review this PR? |
noguchi-takahiro
left a comment
There was a problem hiding this comment.
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 <114006024+noguchi-takahiro@users.noreply.github.com>
Co-authored-by: Takahiro <114006024+noguchi-takahiro@users.noreply.github.com>
Co-authored-by: Takahiro <114006024+noguchi-takahiro@users.noreply.github.com>
Co-authored-by: Takahiro <114006024+noguchi-takahiro@users.noreply.github.com>
Thanks @noguchi-takahiro, I have implemented these and re-written the section in question. Please let me know what you think. |
noguchi-takahiro
left a comment
There was a problem hiding this comment.
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:
machineandoperating pointsections todocumentation.rstfilemachineandoperating pointsections tocode.rstfileclose #312