Skip to content

Conversation

@emolter
Copy link
Collaborator

@emolter emolter commented Feb 4, 2025

This PR addresses an issue that the ruff formatter does not play nicely with spec strings. The parser for the spec string expects everything to be on one line: name, datatype, and description. This information is parsed into help strings to be shown by e.g., strun step_name --help. There is no easy way to get the help strings to render correctly unless everything is on the same line. Therefore, spec strings should ignore the line length rule.

This PR also fixes all instances of spec string lines wrapping onto multiple lines.

Tasks

  • request a review from someone specific, to avoid making the maintainers review every PR
  • add a build milestone, i.e. Build 11.3 (use the latest build if not sure)
  • Does this PR change user-facing code / API? (if not, label with no-changelog-entry-needed)
    • write news fragment(s) in changes/: echo "changed something" > changes/<PR#>.<changetype>.rst (see below for change types)
    • update or add relevant tests
    • update relevant docstrings and / or docs/ page
    • start a regression test and include a link to the running job (click here for instructions)
      • Do truth files need to be updated ("okified")?
        • after the reviewer has approved these changes, run okify_regtests to update the truth files
  • if a JIRA ticket exists, make sure it is resolved properly
news fragment change types...
  • changes/<PR#>.general.rst: infrastructure or miscellaneous change
  • changes/<PR#>.docs.rst
  • changes/<PR#>.stpipe.rst
  • changes/<PR#>.datamodels.rst
  • changes/<PR#>.scripts.rst
  • changes/<PR#>.set_telescope_pointing.rst
  • changes/<PR#>.pipeline.rst

stage 1

  • changes/<PR#>.group_scale.rst
  • changes/<PR#>.dq_init.rst
  • changes/<PR#>.emicorr.rst
  • changes/<PR#>.saturation.rst
  • changes/<PR#>.ipc.rst
  • changes/<PR#>.firstframe.rst
  • changes/<PR#>.lastframe.rst
  • changes/<PR#>.reset.rst
  • changes/<PR#>.superbias.rst
  • changes/<PR#>.refpix.rst
  • changes/<PR#>.linearity.rst
  • changes/<PR#>.rscd.rst
  • changes/<PR#>.persistence.rst
  • changes/<PR#>.dark_current.rst
  • changes/<PR#>.charge_migration.rst
  • changes/<PR#>.jump.rst
  • changes/<PR#>.clean_flicker_noise.rst
  • changes/<PR#>.ramp_fitting.rst
  • changes/<PR#>.gain_scale.rst

stage 2

  • changes/<PR#>.assign_wcs.rst
  • changes/<PR#>.badpix_selfcal.rst
  • changes/<PR#>.msaflagopen.rst
  • changes/<PR#>.nsclean.rst
  • changes/<PR#>.imprint.rst
  • changes/<PR#>.background.rst
  • changes/<PR#>.extract_2d.rst
  • changes/<PR#>.master_background.rst
  • changes/<PR#>.wavecorr.rst
  • changes/<PR#>.srctype.rst
  • changes/<PR#>.straylight.rst
  • changes/<PR#>.wfss_contam.rst
  • changes/<PR#>.flatfield.rst
  • changes/<PR#>.fringe.rst
  • changes/<PR#>.pathloss.rst
  • changes/<PR#>.barshadow.rst
  • changes/<PR#>.photom.rst
  • changes/<PR#>.pixel_replace.rst
  • changes/<PR#>.resample_spec.rst
  • changes/<PR#>.residual_fringe.rst
  • changes/<PR#>.cube_build.rst
  • changes/<PR#>.extract_1d.rst
  • changes/<PR#>.resample.rst

stage 3

  • changes/<PR#>.assign_mtwcs.rst
  • changes/<PR#>.mrs_imatch.rst
  • changes/<PR#>.tweakreg.rst
  • changes/<PR#>.skymatch.rst
  • changes/<PR#>.exp_to_source.rst
  • changes/<PR#>.outlier_detection.rst
  • changes/<PR#>.tso_photometry.rst
  • changes/<PR#>.stack_refs.rst
  • changes/<PR#>.align_refs.rst
  • changes/<PR#>.klip.rst
  • changes/<PR#>.spectral_leak.rst
  • changes/<PR#>.source_catalog.rst
  • changes/<PR#>.combine_1d.rst
  • changes/<PR#>.ami.rst

other

  • changes/<PR#>.wfs_combine.rst
  • changes/<PR#>.white_light.rst
  • changes/<PR#>.cube_skymatch.rst
  • changes/<PR#>.engdb_tools.rst
  • changes/<PR#>.guider_cds.rst

Copy link
Collaborator

@melanieclarke melanieclarke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks! I checked the outlier_detection and jump help messages and the help messages that were missing have been restored.

The style checks will probably catch this when they are enabled for more modules, but many of the inline noqa comments are missing a space, after the closing """.

It seems a little silly for this change, but we should probably run regression tests to make sure nothing is broken.

@codecov
Copy link

codecov bot commented Feb 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.73%. Comparing base (905445b) to head (e15eec2).
Report is 873 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #9139      +/-   ##
==========================================
- Coverage   77.64%   73.73%   -3.91%     
==========================================
  Files         509      372     -137     
  Lines       46794    37274    -9520     
==========================================
- Hits        36332    27485    -8847     
+ Misses      10462     9789     -673     
Flag Coverage Δ
nightly ?

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@emolter
Copy link
Collaborator Author

emolter commented Feb 4, 2025

https://github.com/spacetelescope/RegressionTests/actions/runs/13142380416 regression tests here

The style checks will probably catch this when they are enabled for more modules, but many of the inline noqa comments are missing a space, after the closing """.

If it's ok with you, I'd rather let the formatter handle these when needed. I don't find them difficult to read or anything like that.

@emolter
Copy link
Collaborator Author

emolter commented Feb 4, 2025

Regtest failures match main: only the 12 failing fgs_guider tests

@emolter emolter requested a review from melanieclarke February 4, 2025 20:08
@melanieclarke melanieclarke merged commit 2487ba5 into spacetelescope:main Feb 4, 2025
29 of 32 checks passed
@emolter emolter deleted the noqa-spec branch February 4, 2025 20:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment