Skip to content

Fix SCons option documentation#1790

Merged
ischoegl merged 3 commits intoCantera:mainfrom
ischoegl:fix-1767
Sep 15, 2024
Merged

Fix SCons option documentation#1790
ischoegl merged 3 commits intoCantera:mainfrom
ischoegl:fix-1767

Conversation

@ischoegl
Copy link
Copy Markdown
Member

@ischoegl ischoegl commented Sep 3, 2024

Changes proposed in this pull request

Ensure that all SCons options are listed (instead of documenting the configuration of the build system)

If applicable, fill in the issue number this pull request is fixing

Closes #1767

If applicable, provide an example illustrating new features this pull request is introducing

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 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.24%. Comparing base (ec0cfdb) to head (8efe1dd).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1790   +/-   ##
=======================================
  Coverage   73.23%   73.24%           
=======================================
  Files         381      381           
  Lines       54375    54375           
  Branches     9251     9251           
=======================================
+ Hits        39823    39826    +3     
+ Misses      11580    11578    -2     
+ Partials     2972     2971    -1     

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

@ischoegl ischoegl marked this pull request as ready for review September 3, 2024 02:02
Buffering variables before configuration options are adjusted to the
build system ensures that all SCons options are properly documented.
@ischoegl ischoegl requested a review from a team September 3, 2024 03:33
Copy link
Copy Markdown
Member

@bryanwweber bryanwweber left a comment

Choose a reason for hiding this comment

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

LGTM thanks!

@ischoegl ischoegl merged commit 3f7d0ff into Cantera:main Sep 15, 2024
@ischoegl ischoegl deleted the fix-1767 branch September 15, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Incomplete SCons options on new website

2 participants