OPSIM-1107 Documentation restructure #387
Conversation
rhiannonlynne
force-pushed
the
tickets/OPSIM-1107
branch
from
21b1caa
to
99f3efd
Compare
Ruff for moving_objects ruff for satellite constellations ruff Ruff and docstrings phot_utils
Doc typos ruff and doc strings maf
ruff cleanup ruff and docstrings in metric_bundles Ruff and docstrings
rhiannonlynne
force-pushed
the
tickets/OPSIM-1107
branch
from
d70831b
to
7ac0015
Compare
|
This still isn't finished, but I'm running out of steam and will have to just make another ticket to finish ruff and docstrings in the remainder of the MAF module. |
| @@ -12,14 +12,16 @@ def make_metric_list(outfile): | |||
| # Print header | |||
| print(".. py:currentmodule:: rubin_sim.maf", file=f) | |||
| print("", file=f) | |||
| print(".. _rubin_sim.maf_metricist:", file=f) | |||
| print(".. _maf-metric-list:", file=f) | |||
There was a problem hiding this comment.
A slightly slicker way to do all this is to use context managers to open the file and redirect stdout, and then a bare print statement with a multi-line string, but of course this is fine.
rubin_sim/maf/maf_contrib/calculate_lsst_field_visibility_astropy.py
Outdated
Show resolved
Hide resolved
rubin_sim/maf/maf_contrib/calculate_lsst_field_visibility_astropy.py
Outdated
Show resolved
Hide resolved
| If updating self, resets fnu to None. | ||
| Method will first check if resampling needs to be done or not, unless 'force' is True. | ||
| Method will first check if resampling needs to be done or not, | ||
| unless 'force' is True. |
There was a problem hiding this comment.
Maybe a parameters section could be added here.
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #387 +/- ##
==========================================
+ Coverage 55.25% 58.31% +3.05%
==========================================
Files 305 295 -10
Lines 29681 28102 -1579
Branches 4285 3989 -296
==========================================
- Hits 16400 16387 -13
+ Misses 12338 10770 -1568
- Partials 943 945 +2 ☔ View full report in Codecov by Sentry. |
Restructuring the documentation to work for the Rubin user guide.
There are lots of ruff updates as well, to bring documentation lines into line length compliances and sometimes to update and improve the documentation too.