astropy / astropy/sphinx-astropy
Missing parentheses in SourceProperties/source_properties example call
- Dominant language
- Python
- Stars
- 7
- Forks
- 19
- Avg merge
- 5h 41m
- Merged PRs (30d)
- 1
Description
Edit: This has been moved over from photutils. Rendered issue is visible here: https://photutils.readthedocs.io/en/latest/api/photutils.segmentation.source_properties.html#photutils.segmentation.source_properties
-------------
In the online docs for both the source_properties() function and the SourceProperties class, the example call with all arguments listed is missing parentheses around the kron_params tuple entries:

I think it should be:
photutils.segmentation.source_properties(data, segment_img, error=None, mask=None,
background=None, filter_kernel=None,
wcs=None, labels=None,
localbkg_width=None,
kron_params=**(**'mask', 2.5, 0.0, 'exact', 5**)**)
I would have fixed it myself, but it seems to be fine in all of the source code, and it runs well. Is this just an issue with the online docs?
Thanks!
Contributor guide
No contributing guide indexed for this repository
Research direction
Inspect the rendered API documentation for the source_properties() function and SourceProperties class, then compare their displayed all-arguments example with the source signature. Done means the kron_params tuple entries are shown with the required parentheses in both online examples.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100