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

Improve documentation of modes #1895

Merged
merged 10 commits into from
Sep 28, 2024
Merged

Improve documentation of modes #1895

merged 10 commits into from
Sep 28, 2024

Conversation

gdalle
Copy link
Contributor

@gdalle gdalle commented Sep 26, 2024

Fix #1881 by adding systematic documentation for the Mode subtypes and helper functions.
This PR doesn't change a single line of actual code.

@codecov-commenter
Copy link

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 71.93%. Comparing base (037dfed) to head (0722824).
Report is 101 commits behind head on main.

❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #1895      +/-   ##
==========================================
+ Coverage   67.50%   71.93%   +4.42%     
==========================================
  Files          31       31              
  Lines       12668    13652     +984     
==========================================
+ Hits         8552     9820    +1268     
+ Misses       4116     3832     -284     
Flag Coverage Δ
71.93% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

@gdalle gdalle requested a review from wsmoses September 27, 2024 21:02
@gdalle
Copy link
Contributor Author

gdalle commented Sep 27, 2024

@wsmoses this is up-to-date with main and ready for review nb 2

@gdalle gdalle force-pushed the gd/modes_doc branch 2 times, most recently from cb83444 to 45aed60 Compare September 28, 2024 06:44
@gdalle gdalle marked this pull request as draft September 28, 2024 07:19
@gdalle
Copy link
Contributor Author

gdalle commented Sep 28, 2024

I've merged the latest changes in main and tried to minimize the diff for the final review

@gdalle gdalle marked this pull request as ready for review September 28, 2024 07:25
@wsmoses wsmoses merged commit edd0095 into EnzymeAD:main Sep 28, 2024
10 of 24 checks passed
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.

Inconsistency in mode type parameters for ReverseModeSplit
3 participants