You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
In this docs page: https://petrofit.readthedocs.io/en/stable/photometry.html there is a bullet list near "four plots are displayed" that does not seem to have rendered correctly (though it looks fine if I open the notebook in the repository).
In general it would be useful to link references to functions (let's say get_default_sersic_bounds in https://petrofit.readthedocs.io/en/stable/fitting.html to be concrete) to the corresponding entries in the API documentation using sphinx's crossreferencing features.
One step further, using intersphinx it's also possible to link to external docs pages. As one illustrative example, in https://petrofit.readthedocs.io/en/stable/fitting.html, there is "PetroFit uses the astropy modeling sub-module". It seems like it would make sense for "astropy" and/or "modeling" to link to the relevant documentation from astropy. I'm not sure if/how intersphinx works with docs generated from notebooks...
Some function docstrings are missing documentation of return values, such as petrofit.modeling.petrosian_profile (numpydoc could be used to find all such omissions).
segmentation module has several functions missing parameter descriptions in docstrings.
Several functions in utils module missing docstrings. If these are meant to be for internal use only, mark as private with leading underscore and ask sphinx to omit private members from documentation?
get_default_sersic_boundsin https://petrofit.readthedocs.io/en/stable/fitting.html to be concrete) to the corresponding entries in the API documentation using sphinx's crossreferencing features.intersphinxit's also possible to link to external docs pages. As one illustrative example, in https://petrofit.readthedocs.io/en/stable/fitting.html, there is "PetroFit uses the astropy modeling sub-module". It seems like it would make sense for "astropy" and/or "modeling" to link to the relevant documentation from astropy. I'm not sure if/how intersphinx works with docs generated from notebooks...petrofit.modeling.petrosian_profile(numpydoccould be used to find all such omissions).segmentationmodule has several functions missing parameter descriptions in docstrings.utilsmodule missing docstrings. If these are meant to be for internal use only, mark as private with leading underscore and ask sphinx to omit private members from documentation?This issue is part of my PyOpenSci review. For review pass/fail purposes, resolving it is optional.