Closed vmarois closed 6 years ago
tkornuta-ibm
commented
6 years ago This pull request fixes 1 alert when merging bf13f76d9dbdaad81fee461dab503f30ce33190a into 6801aaec7a056a4bef4d6e80ff1263e8dc536402 - view on LGTM.com
fixed alerts:
Comment posted by LGTM.com
tkornuta-ibm
commented
6 years ago This pull request fixes 1 alert when merging bf13f76d9dbdaad81fee461dab503f30ce33190a into dbb101c6cc05b6eb0e7e8ac7209973ddcc569e7f - view on LGTM.com
fixed alerts:
Comment posted by LGTM.com
tkornuta-ibm
commented
6 years ago LGTM is amazing! 👍
tkornuta-ibm
commented
6 years ago This pull request fixes 1 alert when merging 70fdd449c3159bf90cd342db7febfb089e769b87 into caf29b509e1326cba83beda3f675a49f4766694b - view on LGTM.com
fixed alerts:
Comment posted by LGTM.com
In this PR, I am enhancing the documentation by doing a couple things:
Adding the content of the multiple papers as 4 explained sections: Mi-Prometheus, Workers, Models & Problems. This should allow any user to get a good understanding of what Mi-Prometheus is. Closes #11
Changing slightly the package reference so that it is easier to read and navigate through. I am respecting the rule
package.module.class, as this reflects how a user would facemiprometheusfrom an API standpoint. Closes #4Added an (empty) _tutorials_which will be filled in with basics examples of how to use Mi-Prometheus.
There are still a few things to do to enhance further the documentation:
paramswhich is not very explicit.. This should be a team effort :slightly_smiling_face:modelspackage. Even though theproblemspackage is messier, it is easier to represent in the documentation, as each problem is constituted of one class (located in one file). For the models, this is not the case, as each model is constituted of several classes (and files). Not sure yet how we could do this. miprometheus.utils&miprometheus.workers` are very good examples of documentation organization, as they are just one level deep for the folders architecture.I'm opening an issue for the 2 first points above.