DOC: Continue to fix some simple broken ref across package #9777
Conversation
github-actions
bot
added
ami
assign_wcs
associations
combine_1d
dark_current
extract_1d
outlier_detection
photom
pipeline
resample
tweakreg
wfs_combine
stpipe
datamodels
NIRSPEC
MIRI
NIRISS
FGS
NIRCAM
testing
image3 pipeline
coron3 pipeline
spec3 pipeline
documentation
Wide Field Slitless Spec (WFSS)
assign_mtwcs
wfss_contam
master_background
labels
by addressing some low-hanging fruits
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9777 +/- ##
=======================================
Coverage 82.49% 82.49%
=======================================
Files 366 366
Lines 37134 37134
=======================================
Hits 30633 30633
Misses 6501 6501 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
formatting
and clean up devel_io_design formatting
| * ``--oversample``: The oversampling factor to be used in the model fit (default=3). | ||
| * ``--rotation``: Initial guess for the rotation of the PSF in the input image, in | ||
| units of degrees (default=0.0). | ||
| * ``--psf_offset``: List of PSF offset values to use when creating the model array | ||
| (default='0.0 0.0'). | ||
| * ``--rotation_search``: List of start, stop, and step values that define the list of | ||
| rotation search values. The default setting of '-3 3 1' | ||
| results in search values of [-3, -2, -1, 0, 1, 2, 3]. | ||
| * ``--bandpass``: ASDF file containing suitable array to override filter/source | ||
| (default=None) | ||
| * ``--usebp``: If True, exclude pixels marked DO_NOT_USE from fringe fitting | ||
| (default=True) | ||
| * ``--firstfew``: If not None, process only the first few integrations (default=None) | ||
| * ``--chooseholes``: If not None, fit only certain fringes e.g. ['B4','B5','B6','C2'] | ||
| (default=None) | ||
| * ``--affine2d``: ASDF file containing user-defined affine parameters (default='commissioning') | ||
| * ``--run_bpfix``: Run Fourier bad pixel fix on cropped data (default=True) |
There was a problem hiding this comment.
I like that you put the arguments in inline code formatting, but I also did like the previous columns alignment compared to the new one:
I don't know how these blocks were made, though; perhaps if you prepended :- to each line it would align the columns again?
There was a problem hiding this comment.
Single dash is actually wrong if we are talking about CLI options. I have no idea why colon was even used as a list. It is not a valid Sphinx thingy.
There was a problem hiding this comment.
The red and green background must be because you are not looking at the proper HTML output. They not supposed to be there.
There was a problem hiding this comment.
What exactly you not like about the diff? Please see the rendered RTD page. Thanks.
This PR addresses a little bit of #9383 , as seen in #9666 .
This round touches a lot of subpackages because I tried to do global search and replace for common offenders. Hopefully the diff is self-explanatory.
No need to run RT.
Tasks
Build 12.0(use the latest build if not sure)no-changelog-entry-needed)changes/:echo "changed something" > changes/<PR#>.<changetype>.rst(see changelog readme for instructions)docs/pageokify_regteststo update the truth files