Updated documentation for SEIR function

Priesemann-Group / covid19_inference

Bayesian python toolbox for inference and forecast of the spread of the Coronavirus

GNU General Public License v3.0

73 stars 70 forks source link

Updated documentation for SEIR function #25

Closed emilIftekhar closed 4 years ago

emilIftekhar commented 4 years ago

apart from that I was playing around with the notebooks to check the dense mass matrix approach

jdehning commented 4 years ago

Did you try to build the documentation, there are a number of errors, or wasn't it finished yet? In this case convert it to draft, upper right corner. The errors:

a missing r at the beginning of the the documentation string (for raw format, because to don't evaluate the special characters_
there should be empty lines at the beginning and end of the math block.
In the 3rd row of the math block, an alignment & is missing

The instructions on how to build the docs are in the documentation, in the 'contributing' section. Otherwise, do also specify how β_i is distributed And for the pull request, please only include the files that are relevant. Here are 5 extraneous files that are changed/added. I think the best method is to create a new branch for the pull request.

emilIftekhar commented 4 years ago

Sorry for the errors! Also, I forgot about the build the docs thing. I ran it through blacks now. To PR only the one file, I have to clone the repo again, create a new branch, only add the edited file and then make the pull request, right?

jdehning commented 4 years ago

That should work. But I think it is also possible to create a branch on you current repo and merge the current master of the official repo into it.

On Sat, Apr 25, 2020, 16:42 emilIftekhar notifications@github.com wrote:

Sorry for the errors! Also, I forgot about the build the docs thing. I ran it through blacks now. To PR only the one file, I have to clone the repo again, create a new branch, only add the edited file and then make the pull request, right?

— You are receiving this because you commented. Reply to this email directly, view it on GitHub https://github.com/Priesemann-Group/covid19_inference/pull/25#issuecomment-619389706, or unsubscribe https://github.com/notifications/unsubscribe-auth/ACHYEN5BX6JCYUSQUC2UT5LROLZGHANCNFSM4MQXEMJQ .