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

Update isotope documentation #1807

Merged
merged 1 commit into from
Nov 20, 2019
Merged

Conversation

goldmanm
Copy link
Contributor

@goldmanm goldmanm commented Nov 5, 2019

This commit updates the isotope documentation by linking a publication
and its corresponding scripts, as well as mentioning a caveat when
regenerating all the reactions from the start.

Testing

Built locally, checked spelling, viewed in browser, made sure links function

Reviewer Tips

See if the writing makes sense.

@goldmanm goldmanm force-pushed the isotope_documentation_updates branch from 39525f8 to dbc2baa Compare November 5, 2019 18:36
@codecov
Copy link

codecov bot commented Nov 5, 2019

Codecov Report

Merging #1807 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1807   +/-   ##
=======================================
  Coverage   43.02%   43.02%           
=======================================
  Files          80       80           
  Lines       21099    21099           
  Branches     5516     5516           
=======================================
  Hits         9077     9077           
+ Misses      11004    10990   -14     
- Partials     1018     1032   +14
Impacted Files Coverage Δ
arkane/kinetics.py 12.14% <0%> (ø) ⬆️
rmgpy/data/statmech.py 42.2% <0%> (ø) ⬆️
rmgpy/rmg/pdep.py 12.21% <0%> (ø) ⬆️
rmgpy/data/kinetics/database.py 50.61% <0%> (ø) ⬆️
rmgpy/data/kinetics/family.py 48.35% <0%> (ø) ⬆️
rmgpy/statmech/ndTorsions.py 59.78% <0%> (ø) ⬆️
rmgpy/yml.py 15.71% <0%> (ø) ⬆️
arkane/sensitivity.py 10% <0%> (ø) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3116f08...2d0def3. Read the comment docs.

Copy link
Member

@alongd alongd left a comment

Choose a reason for hiding this comment

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

Thanks, I added minor comments

documentation/source/users/rmg/modules/isotopes.rst Outdated Show resolved Hide resolved

A description of mechanisms generated using this module and its application to
obtaining intramolecular isotopic enrichment information is described in
Chemical Geology, Volume 514, page 1, doi: https://doi.org/10.1016/j.chemgeo.2019.02.036
Copy link
Member

Choose a reason for hiding this comment

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

could you make these doi's clickable?
use this example format for rst:

`Molpro <https://www.molpro.net/>`_

Copy link
Contributor Author

Choose a reason for hiding this comment

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

fixed and checked to ensure it built properly with links

This commit updates the isotope documentation by linking a publication
and its corresponding scripts, as well as mentioning a caveat when
regenerating all the reactions from the start.
@goldmanm goldmanm force-pushed the isotope_documentation_updates branch from dbc2baa to 2d0def3 Compare November 20, 2019 18:38
@goldmanm goldmanm merged commit 853f205 into master Nov 20, 2019
@goldmanm goldmanm deleted the isotope_documentation_updates branch November 20, 2019 21:36
@mliu49 mliu49 mentioned this pull request Dec 16, 2019
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.

3 participants