-
-
Notifications
You must be signed in to change notification settings - Fork 355
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
Update example formatting for better sphinx-gallery rendering #1821
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1821 +/- ##
==========================================
- Coverage 73.25% 73.24% -0.01%
==========================================
Files 383 383
Lines 54624 54624
Branches 9103 9103
==========================================
- Hits 40015 40012 -3
- Misses 11603 11605 +2
- Partials 3006 3007 +1 ☔ View full report in Codecov by Sentry. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some small suggestions, thanks @speth!
Also add some sphinx-gallery headings and switch to Axes-based plotting
Provide better explanations of what the example is showing, and add plots of the temperature and pressure to better illustrate the resulting flow characteristics.
2f9f92f
to
2e6d7ee
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, @speth!
Changes proposed in this pull request
sphinx-gallery
section headings / description blocks to several examplessphinx-gallery
) and useplt.show()
more consistently for when examples are run from the command linepiston.py
,mechanism_reduction.py
,isentropic.py
, andblowers_masel.py
overwrite
flags when saving 1D flame dataChecklist
scons build
&scons test
) and unit tests address code coverage