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 documentation from py2 to py3 #1767

Merged
merged 21 commits into from
Oct 29, 2019
Merged

Update documentation from py2 to py3 #1767

merged 21 commits into from
Oct 29, 2019

Conversation

hwpang
Copy link
Contributor

@hwpang hwpang commented Oct 12, 2019

Motivation or Problem

Update documentation from py2 to py3 and fix some wrong import directory.

Description of Changes

A clear and concise description of what what you've changed or added.

Testing

After changes, make html builds build/html/ for RMG-Py3 successfully.

Reviewer Tips

Suggestions for verifying that this PR works or other notes for the reviewer.

fixes #1772

@codecov
Copy link

codecov bot commented Oct 12, 2019

Codecov Report

Merging #1767 into master will not change coverage.
The diff coverage is 75%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1767   +/-   ##
=======================================
  Coverage   32.61%   32.61%           
=======================================
  Files          87       87           
  Lines       26124    26124           
  Branches     6878     6878           
=======================================
  Hits         8521     8521           
+ Misses      16644    16633   -11     
- Partials      959      970   +11
Impacted Files Coverage Δ
rmgpy/molecule/atomtype.py 0% <ø> (ø) ⬆️
rmgpy/molecule/element.py 0% <ø> (ø) ⬆️
rmgpy/data/statmechfit.py 46.09% <0%> (ø) ⬆️
rmgpy/molecule/__init__.py 100% <100%> (ø) ⬆️
rmgpy/data/kinetics/__init__.py 100% <100%> (ø) ⬆️
rmgpy/data/statmech.py 42.2% <0%> (ø) ⬆️
rmgpy/rmg/pdep.py 12.21% <0%> (ø) ⬆️
rmgpy/reaction.py 0% <0%> (ø) ⬆️
rmgpy/data/kinetics/family.py 48.35% <0%> (ø) ⬆️
rmgpy/yml.py 15.71% <0%> (ø) ⬆️
... and 4 more

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 f70d761...96c0972. Read the comment docs.

===================== =================== ====================================

"""

def __init__(self, label='',
def __init__(self, label=``,
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you probably didn't intend to replace all ' with ` in this file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@mliu49 I only intended to change the ' in the docstring block. I've recovered those that should have remained '.

@amarkpayne
Copy link
Member

Thanks for the PR @hwpang ! I hope you don't mind I have pushed two additional commits that update the installation section of the documentation now that we are using python 3.

@mliu49 mliu49 mentioned this pull request Oct 15, 2019
17 tasks
@ajocher
Copy link
Contributor

ajocher commented Oct 15, 2019

Thank you! I hope this is the right pull request to update the description for the RMG-database scripts with Python 3?

@amarkpayne
Copy link
Member

Thank you! I hope this is the right pull request to update the description for the RMG-database scripts with Python 3?

Yes, thanks @ajocher !

@mliu49
Copy link
Contributor

mliu49 commented Oct 21, 2019

I pushed a few more fixes to the documentation. Please review the new changes and squash when ready. I think the other changes look good.

Copy link
Member

@amarkpayne amarkpayne left a comment

Choose a reason for hiding this comment

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

These additional changes look good to me. @hwpang can you rebase this branch to update to master and squash some of the commits? Otherwise I think this PR is ready to go and can get merged in today.

@mliu49
Copy link
Contributor

mliu49 commented Oct 28, 2019

I squashed and rebased on master. The last two commits are new.

@amarkpayne amarkpayne merged commit dfe7744 into master Oct 29, 2019
@amarkpayne amarkpayne deleted the updateDoc branch October 29, 2019 14:14
@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.

Installation instructions to build from source need updating
4 participants