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 glossary to documentation #202

Merged
merged 3 commits into from
Dec 6, 2024
Merged

Add glossary to documentation #202

merged 3 commits into from
Dec 6, 2024

Conversation

backmari
Copy link
Contributor

@backmari backmari commented Dec 5, 2024

Description of the changes

Add a glossary to the documentation and address other comments from the internal review.

Check all that apply:

  • updated documentation
  • Source added/refactored
  • Added unit tests
  • Added integration tests
  • (If applicable) Verified that manual tests requiring the /SNS and /HFIR filesystems pass without fail

References:

Manual test for the reviewer

(Instructions for testing here)

Check list for the reviewer

  • best software practices
    • clearly named variables (better to be verbose in variable names)
    • code comments explaining the intent of code blocks
  • All the tests are passing
  • The documentation is up to date
  • code comments added when explaining intent

@codecov-commenter
Copy link

codecov-commenter commented Dec 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.78%. Comparing base (462ed48) to head (be37490).

Additional details and impacted files
@@           Coverage Diff           @@
##             next     #202   +/-   ##
=======================================
  Coverage   77.78%   77.78%           
=======================================
  Files          54       54           
  Lines        4709     4709           
=======================================
  Hits         3663     3663           
  Misses       1046     1046           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@backmari backmari requested a review from hetrickjm December 6, 2024 14:53
docs/glossary.rst Outdated Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
docs/glossary.rst Outdated Show resolved Hide resolved
@backmari backmari merged commit 4e9e7d1 into next Dec 6, 2024
4 checks passed
@backmari backmari deleted the docs_glossary branch December 6, 2024 17:29
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.

3 participants