8000 Adding tutorial to docs by jbscoggi · Pull Request #83 · mutationpp/Mutationpp · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

Adding tutorial to docs #83

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 4 commits into from
Jun 13, 2019
Merged

Adding tutorial to docs #83

merged 4 commits into from
Jun 13, 2019

Conversation

jbscoggi
Copy link
Member
@jbscoggi jbscoggi commented Jun 7, 2019

This PR adds a first attempt at creating a tutorial for Mutation++. It serves to introduce the user to the basic usage and concepts in the library.

@jbscoggi jbscoggi requested a review from grgbellasvki June 7, 2019 13:45
@jbscoggi
Copy link
Member Author
jbscoggi commented Jun 7, 2019

Hey @grgbellasvki, do you mind to take a quick look at this in the next few days and do a review. It's not much, just looking for some feedback on the tutorial.

grgbellasvki
grgbellasvki reviewed Jun 11, 2019
View reviewed changes
grgbellasvki
grgbellasvki requested changes Jun 11, 2019
View reviewed changes

Copy link
Collaborator
@grgbellasvki grgbellasvki left a comment

Choose a reason for hiding this comment

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

The tutorial seems clear and very well written. Just some minor comments.
If you where to extend it what would you add?

@jbscoggi
Copy link
Member Author

@grgbellasvki, I'm not sure I would extend it much beyond this actually. I think it is a descent intro into how to use the code without going into too much detail. Probably what I would do instead is create a series of more targeted tutorials devoted to specific topics. These can come at a later stage I think.

@codecov-io
Copy link

Codecov Report

Merging #83 into master will increase coverage by 0.19%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #83      +/-   ##
==========================================
+ Coverage   72.82%   73.01%   +0.19%     
==========================================
  Files         134      134              
  Lines        8559     8561       +2     
==========================================
+ Hits         6233     6251      +18     
+ Misses       2326     2310      -16
Impacted Files Coverage Δ
src/general/MixtureOptions.h 100% <0%> (ø) ⬆️
src/thermo/RrhoDB.cpp 86.11% <0%> (+4.86%) ⬆️
src/kinetics/Reaction.h 100% <0%> (+5.71%) ⬆️

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 39b6386...de3f144. Read the comment docs.

@jbscoggi jbscoggi requested a review from grgbellasvki June 13, 2019 08:13
@grgbellasvki grgbellasvki merged commit bf39032 into mutationpp:master Jun 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@grgbellasvki grgbellasvki Awaiting requested review from grgbellasvki

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jbscoggi @codecov-io @grgbellasvki
0