v0.1 Documentation Hack

skypyproject / skypy

SkyPy: A package for modelling the Universe.

BSD 3-Clause "New" or "Revised" License

118 stars 38 forks source link

v0.1 Documentation Hack #99

Closed rrjbca closed 4 years ago

rrjbca commented 4 years ago

In advance of v0.1 release we will have a hack to fix and improve existing documentation. The documentation can be viewed here. Some issues already identified:

~No documentation for skypy.halo.mass (AL) or skypy.utils (RR)~
Documentation for SkyPyDriver rendering poorly
~CI badges on front page (GitHub actions, fix CircleCI,~ zenodo, ~pypi...)~
~Docstring for the whole package to the top-level ./skypy/init.py~
~On the repo homepage "No description, website, or topics provided."~

jucordero commented 4 years ago

~A few typos in the Eisenstein & Hu module that I should fix.~

philipp128 commented 4 years ago

I found some typos in spectum.dirichlet_coefficients, redshift.herbel_redshift, redshift.herbel_pdf and luminosity.herbel_luminosity which I will work on.

rrjbca commented 4 years ago

Most of the issues identified here have now been addressed; great work everyone! I'll close this issue and open a separate issue specifically for the SkyPyDriver