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

Some small tutorial improvements #226

Merged
merged 5 commits into from
Feb 22, 2024
Merged

Some small tutorial improvements #226

merged 5 commits into from
Feb 22, 2024

Conversation

bhazelton
Copy link
Member

@bhazelton bhazelton commented Jan 5, 2024

Description

Some tutorial tweaks to separate out examples for the various functionality (before some examples showed a bunch of unrelated functionality in the same example). Also added some more text to explain what was going on and made a few figures prettier.

Also ensure that plotting commands are run in the doctests to make sure they work (there have been bugs in the pyuvdata tutorial that we didn't catch because they were in plotting commands that weren't run in the doctests). This required some updates to the docs requirements.

Note: This is best reviewed by looking at the RTD build.

Motivation and Context

Better docs always help :).

Checklists:

Documentation Change Checklist:

@bhazelton bhazelton added the documentation Improvements or additions to documentation label Jan 5, 2024
Copy link

codecov bot commented Jan 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (1cae5da) 99.95% compared to head (fc40fc3) 100.00%.

Additional details and impacted files
@@             Coverage Diff             @@
##             main      #226      +/-   ##
===========================================
+ Coverage   99.95%   100.00%   +0.04%     
===========================================
  Files           5         5              
  Lines        2134      2134              
  Branches      608       608              
===========================================
+ Hits         2133      2134       +1     
+ Misses          1         0       -1     

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

@bhazelton bhazelton force-pushed the tutorial_tweaks branch 2 times, most recently from ec36ec2 to 7ad17f7 Compare January 5, 2024 20:15
@bhazelton bhazelton added this to the JOSS Paper milestone Jan 11, 2024
@bhazelton bhazelton requested a review from jpober February 22, 2024 16:13
jpober
jpober previously approved these changes Feb 22, 2024
@jpober jpober merged commit 4a8b172 into main Feb 22, 2024
38 of 40 checks passed
@jpober jpober deleted the tutorial_tweaks branch February 22, 2024 16:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants