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

SmartSim logger documentation #431

Merged

Conversation

amandarichardsonn
Copy link
Contributor

@amandarichardsonn amandarichardsonn commented Dec 5, 2023

This PR will merge the SmartSim logger documentation into the main SmartSim documentation branch.

@amandarichardsonn amandarichardsonn marked this pull request as draft December 5, 2023 20:13
Copy link

codecov bot commented Dec 5, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (79e8ce5) 90.23% compared to head (a800c05) 90.47%.
Report is 7 commits behind head on smartsim-docs-refresh.

Additional details and impacted files

Impacted file tree graph

@@                    Coverage Diff                    @@
##           smartsim-docs-refresh     #431      +/-   ##
=========================================================
+ Coverage                  90.23%   90.47%   +0.24%     
=========================================================
  Files                         60       60              
  Lines                       3859     3738     -121     
=========================================================
- Hits                        3482     3382     -100     
+ Misses                       377      356      -21     

see 29 files with indirect coverage changes

@amandarichardsonn amandarichardsonn marked this pull request as ready for review December 6, 2023 03:31
@amandarichardsonn amandarichardsonn changed the title Logging doc SmartSim logger documentation Dec 6, 2023
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/index.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@mellis13 mellis13 left a comment

Choose a reason for hiding this comment

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

It's great to see some clearer docs on the logging API. Just a couple of comments/questions to address, but nothing significant.

doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Show resolved Hide resolved
Copy link
Contributor

@mellis13 mellis13 left a comment

Choose a reason for hiding this comment

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

Very small questions/comments. Otherwise very close to merging.

doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Show resolved Hide resolved
doc/ss_logger.rst Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
doc/ss_logger.rst Outdated Show resolved Hide resolved
Copy link
Contributor

@mellis13 mellis13 left a comment

Choose a reason for hiding this comment

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

LGTM -- thanks!

@amandarichardsonn amandarichardsonn merged commit 6a3f963 into CrayLabs:smartsim-docs-refresh Jan 9, 2024
26 checks passed
@amandarichardsonn amandarichardsonn deleted the logging_doc branch January 9, 2024 21:18
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.

5 participants