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

Tidy up some docstrings. #350

Merged
merged 2 commits into from
Jan 17, 2024
Merged

Tidy up some docstrings. #350

merged 2 commits into from
Jan 17, 2024

Conversation

delucchi-cmu
Copy link
Contributor

Change Description

Addresses a handful of docstring rendering issues.

Also includes some quality-of-life changes while working on documentation:

  • no-nb build option now really does ignore notebooks while rendering
  • make no-nb puts things in the docs/autoapi directory, and should be ignored.

Code Quality

  • My code builds (or compiles) cleanly without any errors or warnings
  • My code contains relevant comments and necessary documentation

Documentation Change Checklist

Copy link

github-actions bot commented Jan 17, 2024

Before [f69be16] After [3c9d1cd] Ratio Benchmark (Parameter)
45.8±0.7ms 44.2±0.7ms 0.97 benchmarks.time_batch
49.8±0.8ms 47.7±0.7ms 0.96 benchmarks.time_prune_sync_workflow

Click here to view all benchmarks.

Copy link

codecov bot commented Jan 17, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (f69be16) 95.15% compared to head (e4c87f7) 95.15%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #350   +/-   ##
=======================================
  Coverage   95.15%   95.15%           
=======================================
  Files          24       24           
  Lines        1631     1631           
=======================================
  Hits         1552     1552           
  Misses         79       79           

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

@delucchi-cmu delucchi-cmu requested review from wilsonbb and hombit and removed request for wilsonbb January 17, 2024 13:43
Copy link
Contributor

@hombit hombit left a comment

Choose a reason for hiding this comment

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

Thank you!

@delucchi-cmu delucchi-cmu merged commit a3de1be into main Jan 17, 2024
13 checks passed
@delucchi-cmu delucchi-cmu deleted the delucchi/docs branch March 14, 2024 20:00
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.

2 participants