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 section ordering for rsmexplain #667

Merged
merged 7 commits into from
Jan 5, 2024
Merged

Conversation

desilinguist
Copy link
Member

  • rsmexplain now supports section_order field in its configuration.
  • Tweak heading levels in auto cohorts notebook so that it's correctly shown in the TOC no matter where it's included in the output report.
  • Update rsmexplain documentation to add a note about the auto cohorts section and its order.
  • Update expected test outputs.

- Add `section_order` as a valid field for `rsmexplain`.
- Use `section_order` for rsmexplain reports, if available.
- Since the auto cohorts notebook is a self-contained section, its heading levels
should reflect that irrespective of where in the notebook it's included.
- Add explicit note about auto cohorts section being a custom section and how to order it.
- Add more anchors and rename existing anchors to be consistent.
Copy link

codecov bot commented Jan 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (cf8e813) 95.83% compared to head (23e12ea) 95.83%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #667   +/-   ##
=======================================
  Coverage   95.83%   95.83%           
=======================================
  Files          32       32           
  Lines        4488     4489    +1     
=======================================
+ Hits         4301     4302    +1     
  Misses        187      187           

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

@desilinguist desilinguist linked an issue Jan 5, 2024 that may be closed by this pull request
@desilinguist desilinguist merged commit cd4f7f6 into main Jan 5, 2024
10 checks passed
@delete-merged-branch delete-merged-branch bot deleted the 665-fix-auto-cohort-plots branch January 5, 2024 14:20
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.

Auto-cohort plots are incorrectly inserted in report
3 participants