Skip to content

Use unicode superscript in Python docstrings / tweak pickle#1970

Merged
speth merged 4 commits intoCantera:mainfrom
ischoegl:tweak-pickle
Sep 10, 2025
Merged

Use unicode superscript in Python docstrings / tweak pickle#1970
speth merged 4 commits intoCantera:mainfrom
ischoegl:tweak-pickle

Conversation

@ischoegl
Copy link
Copy Markdown
Member

@ischoegl ischoegl commented Sep 8, 2025

Changes proposed in this pull request

  • Replace unicode superscripts in docstrings (in analogy to recent changes in C++ recommendations)
  • Apply changes requested after feat: pickling of SolutionArray objects (fixes #543) #1964 was merged.
  • Avoid creation of Solution and SolutionArray from None (the latter would have caused a hard crash)

As an aside: there could be an argument for typesetting units as math text, but that would result in a much larger scope/effort.

Checklist

  • The pull request includes a clear description of this code change
  • Commit messages have short titles and reference relevant issues
  • Build passes (scons build & scons test) and unit tests address code coverage
  • Style & formatting of contributed code follows contributing guidelines
  • The pull request is ready for review

@codecov
Copy link
Copy Markdown

codecov bot commented Sep 8, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 75.47%. Comparing base (0c561b6) to head (7fef8ae).
⚠️ Report is 5 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1970   +/-   ##
=======================================
  Coverage   75.46%   75.47%           
=======================================
  Files         450      450           
  Lines       56299    56306    +7     
  Branches     9301     9301           
=======================================
+ Hits        42487    42495    +8     
+ Misses      10677    10676    -1     
  Partials     3135     3135           

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

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@ischoegl ischoegl added the Python label Sep 8, 2025
@ischoegl ischoegl marked this pull request as ready for review September 8, 2025 17:56
@ischoegl ischoegl requested a review from a team September 8, 2025 17:56
@ischoegl ischoegl force-pushed the tweak-pickle branch 5 times, most recently from 11d94f8 to ccaa97c Compare September 8, 2025 20:51
@ischoegl
Copy link
Copy Markdown
Member Author

ischoegl commented Sep 8, 2025

This is ready for a review - making sure Solution(None) and SolutionArray(None) raise the appropriate errors took more iterations than anticipated.

Copy link
Copy Markdown
Member

@speth speth left a comment

Choose a reason for hiding this comment

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

Thanks for propagating this style update. I had just a couple of suggestions.

@speth speth merged commit ca88f08 into Cantera:main Sep 10, 2025
51 checks passed
@ischoegl ischoegl deleted the tweak-pickle branch October 19, 2025 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants