Skip to content
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

Open
wants to merge 6 commits into
base: develop
Choose a base branch
from

Conversation

dmnewman3
Copy link
Contributor

@dmnewman3 dmnewman3 commented May 20, 2024

Issue

Address issue #312

Summary

This PR does the following:

  • adds machine and operating point sections to documentation.rst file
  • adds machine and operating point sections to code.rst file

close #312

@dmnewman3 dmnewman3 added the documentation Improvements or additions to documentation label May 20, 2024
@dmnewman3 dmnewman3 added this to the Version 1.1 milestone May 20, 2024
@dmnewman3 dmnewman3 requested a review from wchan29 May 20, 2024 19:10
@dmnewman3 dmnewman3 self-assigned this May 20, 2024
@dmnewman3
Copy link
Contributor Author

@wchan29 @noguchi-takahiro @elsevers Can one of you review this PR?

Copy link
Contributor

@noguchi-takahiro noguchi-takahiro left a 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;

docs/source/code.rst Outdated Show resolved Hide resolved
docs/source/code.rst Outdated Show resolved Hide resolved
docs/source/code.rst Show resolved Hide resolved
docs/source/code.rst Outdated Show resolved Hide resolved
docs/source/code.rst Outdated Show resolved Hide resolved
docs/source/code.rst Outdated Show resolved Hide resolved
@dmnewman3
Copy link
Contributor Author

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;

Thanks @noguchi-takahiro, I have implemented these and re-written the section in question. Please let me know what you think.

Copy link
Contributor

@noguchi-takahiro noguchi-takahiro left a 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on how to code/document machines and operating points
2 participants