Update example formatting for better sphinx-gallery rendering#1821
Merged
speth merged 11 commits intoCantera:mainfrom Dec 2, 2024
Merged
Update example formatting for better sphinx-gallery rendering#1821speth merged 11 commits intoCantera:mainfrom
speth merged 11 commits intoCantera:mainfrom
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. |
bryanwweber
reviewed
Dec 1, 2024
Member
bryanwweber
left a comment
bryanwweber
left a comment
There was a problem hiding this comment.
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.
speth
force-pushed
the
example-formatting
branch
from
2f9f92f to
2e6d7ee
Compare
ischoegl
approved these changes
Dec 2, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes proposed in this pull request
sphinx-gallerysection 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.pyoverwriteflags when saving 1D flame dataChecklist
scons build&scons test) and unit tests address code coverage