Skip to content

Fix docstring parameter names that do not match the signatures - #3642

Closed
darkdi wants to merge 1 commit into
astropy:mainfrom
darkdi:fix/docstring-param-names
Closed

darkdi wants to merge 1 commit into
astropy:mainfrom
darkdi:fix/docstring-param-names

Conversation

@darkdi

@darkdi darkdi commented Aug 5, 2026

Copy link
Copy Markdown

Description

Six Parameters entries name an argument the function does not take. Each was read against its signature before changing.

Where Documented Actual
astroquery/ipac/irsa/core.py:142 query_ssa raidus radius — a typo; the description below it already says "the radius of the circular region"
astroquery/ipac/irsa/irsa_dust/utils.py:80 find_result_node xmlTree xml_tree
astroquery/ipac/ned/core.py:506 _extract_image_urls format file_format
astroquery/linelists/cdms/core.py:619 CDMSClass.find s st (the summary line above still reads "regex match to string s")
astroquery/mast/services.py:252 _parse_result responses response
astroquery/mast/utils.py:533 parse_numeric_product_filter val vals

raidus is the one users would actually hit: it is a public method, so the rendered docs offer a keyword that raises TypeError if copied.

Docstrings only — no signature, call site, or behaviour is touched.

Not included

The same sweep raised twenty more of this kind, spread across cadc, cosmosim, esa/hubble, esa/iso, esa/xmm_newton, mocserver, vizier, wfau and others. I kept this PR to the six that are unambiguous single-name mismatches rather than opening one that touches nine subpackages at once. Happy to send the rest, split per subpackage if you prefer.

Two I deliberately left alone:

  • astroquery/template_module/core.py documents verbose and any_other_param that the template's own signature does not have — but that file is the worked example for new modules, so the placeholders read as intentional.
  • astroquery/esa/utils/utils.py:505 __create_adql_criteria documents query_criteria against a filters parameter; that one looked like it might be a genuine rename in progress rather than a stale tag, and I did not want to guess.

Six Parameters entries name an argument the function does not take, one of
them a plain typo (raidus). Docstrings only.
@codecov

codecov Bot commented Aug 5, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 73.42%. Comparing base (de02e4d) to head (fee3c2c).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #3642   +/-   ##
=======================================
  Coverage   73.42%   73.42%           
=======================================
  Files         230      230           
  Lines       21354    21354           
=======================================
  Hits        15679    15679           
  Misses       5675     5675           

☔ View full report in Codecov by Harness.
📢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants