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 missing doc comments for time slices and processes #403

Merged
merged 5 commits into from
Feb 27, 2025

Conversation

alexdewar
Copy link
Collaborator

Description

This PR adds missing doc comments for time slice- and process-related code. For the time slice code, there's also a small amount of rearranging, but no functional changes are intended anywhere.

Closes #220. Closes #222.

Type of change

  • Bug fix (non-breaking change to fix an issue)
  • New feature (non-breaking change to add functionality)
  • Refactoring (non-breaking, non-functional change to improve maintainability)
  • Optimization (non-breaking change to speed up the code)
  • Breaking change (whatever its nature)
  • Documentation (improve or add documentation)

Key checklist

  • All tests pass: $ cargo test
  • The documentation builds and looks OK: $ cargo doc

Further checks

  • Code is commented, particularly in hard-to-understand areas
  • Tests added that prove fix is effective or that feature works

Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 95.58%. Comparing base (637d49a) to head (eb7af1f).
Report is 6 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #403      +/-   ##
==========================================
+ Coverage   95.56%   95.58%   +0.02%     
==========================================
  Files          31       31              
  Lines        4122     4121       -1     
  Branches     4122     4121       -1     
==========================================
  Hits         3939     3939              
+ Misses         91       90       -1     
  Partials       92       92              

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

Copy link
Collaborator

@TinyMarsh TinyMarsh left a comment

Choose a reason for hiding this comment

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

LGTM

@alexdewar alexdewar force-pushed the add-missing-doc-comments branch from ce60eae to eb7af1f Compare February 27, 2025 09:57
@alexdewar alexdewar enabled auto-merge February 27, 2025 09:57
@alexdewar alexdewar merged commit 54e9a7f into main Feb 27, 2025
7 checks passed
@alexdewar alexdewar deleted the add-missing-doc-comments branch February 27, 2025 10:03
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.

Document time_slice.rs and enable missing_docs warnings Document process.rs and enable missing_docs warnings
2 participants