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

[docs] Clarify coverage-dependent surface species docs #1583

Merged
merged 1 commit into from
Aug 13, 2023

Conversation

ischoegl
Copy link
Member

@ischoegl ischoegl commented Aug 11, 2023

Changes proposed in this pull request

Clarify coverage-dependent surface species documentation

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

Closes #1579

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

codecov bot commented Aug 11, 2023

Codecov Report

Merging #1583 (db1a5d4) into main (4b30fa7) will increase coverage by 0.07%.
Report is 14 commits behind head on main.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main    #1583      +/-   ##
==========================================
+ Coverage   70.51%   70.58%   +0.07%     
==========================================
  Files         379      379              
  Lines       59118    59134      +16     
  Branches    21237    21253      +16     
==========================================
+ Hits        41686    41739      +53     
+ Misses      14359    14322      -37     
  Partials     3073     3073              

see 8 files with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@ischoegl ischoegl requested a review from a team August 11, 2023 14:49
Copy link
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 looking into this @ischoegl. You're definitely right that this was organized incorrectly. I think there's just one remaining part that still needs to be moved to match the actual structure.

doc/sphinx/yaml/species.rst Outdated Show resolved Hide resolved
@ischoegl
Copy link
Member Author

Thanks for the feedback, @speth. This should be ready to merge.

@ischoegl ischoegl requested a review from speth August 13, 2023 02:12
Co-authored-by: Ray Speth <speth@mit.edu>
@speth speth force-pushed the coverage-dependent-species branch from 2a22c37 to db1a5d4 Compare August 13, 2023 19:57
@speth
Copy link
Member

speth commented Aug 13, 2023

@ischoegl, please feel free to merge if this updated version makes sense to you.

@ischoegl ischoegl merged commit e00c23f into Cantera:main Aug 13, 2023
42 checks passed
@ischoegl ischoegl deleted the coverage-dependent-species branch August 13, 2023 20:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Cantera 3.0 website coverage-dependent surface species documentation
2 participants