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

Doc fix #203

Merged
merged 9 commits into from
Jun 21, 2022
Merged

Doc fix #203

merged 9 commits into from
Jun 21, 2022

Conversation

amandarichardsonn
Copy link
Contributor

@amandarichardsonn amandarichardsonn commented Jun 8, 2022

Creating PR for changes.

@codecov-commenter
Copy link

codecov-commenter commented Jun 8, 2022

Codecov Report

Merging #203 (9c6a6dd) into develop (ea44a1e) will decrease coverage by 0.15%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           develop     #203      +/-   ##
===========================================
- Coverage    84.33%   84.17%   -0.16%     
===========================================
  Files           58       59       +1     
  Lines         3223     3312      +89     
===========================================
+ Hits          2718     2788      +70     
- Misses         505      524      +19     
Impacted Files Coverage Δ
smartsim/experiment.py 80.98% <0.00%> (ø)
smartsim/ml/tf/utils.py 95.83% <0.00%> (ø)
smartsim/entity/model.py 96.77% <0.00%> (ø)
smartsim/entity/dbobject.py 87.87% <0.00%> (ø)
smartsim/entity/ensemble.py 99.15% <0.00%> (ø)
smartsim/_core/utils/redis.py 87.23% <0.00%> (ø)
smartsim/database/__init__.py 100.00% <0.00%> (ø)
smartsim/settings/__init__.py 100.00% <0.00%> (ø)
smartsim/settings/settings.py 65.62% <0.00%> (ø)
smartsim/_core/utils/helpers.py 74.41% <0.00%> (ø)
... and 14 more

@amandarichardsonn amandarichardsonn marked this pull request as draft June 8, 2022 18:06
@billschereriii
Copy link
Contributor

Some really good updates here, thank you! A few of the updates need to be adjusteed or reverted though -- see inline above

@amandarichardsonn amandarichardsonn added the API break Issues that include incompatible API changes label Jun 16, 2022
@billschereriii billschereriii removed the API break Issues that include incompatible API changes label Jun 16, 2022
@amandarichardsonn amandarichardsonn marked this pull request as ready for review June 16, 2022 19:56
Copy link
Member

@ashao ashao left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor suggestions. The main thing is to make sure that the line lengths do not exceed 88 characters. While we can rely on black to fix it for us, in between those times, it makes the code nicer to look at.

doc/sr_cpp_walkthrough.rst Outdated Show resolved Hide resolved
doc/sr_cpp_walkthrough.rst Outdated Show resolved Hide resolved
doc/sr_python_walkthrough.rst Outdated Show resolved Hide resolved
doc/sr_python_walkthrough.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@billschereriii billschereriii left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Thanks for pushing through and getting these documentation clarifications in place!

@amandarichardsonn
Copy link
Contributor Author

Edits made to SmartSim documentation to improve writing quality (#203 )

Replacing passive tense with present in SmartSim documentation. Also editing grammar and punctuation errors.

[ committed by @amandarichardsonn ]
[ reviewed by @billschereriii @ashao ]

@amandarichardsonn amandarichardsonn merged commit 6c96157 into CrayLabs:develop Jun 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants