Updated docs and formatting for stack.py, combine.py amd catalog.py
This is in continuation from PR #229 as agreed with @gbrammer .
Specifically:
added missing / completed incomplete docstrings using AI tools
adressed some unused parameters (as this is a part of docs)
went through formatting using black.
In stack.py, one ambiguitie is marked with a TODO comment (optimal_extract method).
in combine.py the docs I made might be overkill for the small methods in SIP_WCSMap class - I chose to be consistent with rest of the code, but that might be too much in this case - since I know this will be reviewed I leave it for evaluation.
In catalog.py, I left a few TODO comments around some parameters that might need more attention. I have made docstrings for all the wrappers for query_tap_catalog - If you would rather have the docstrings reference to the query_tap_catalog instead to make things more compact please let me know - I can easily change this.
In fitting.py I have adressed a handfull of unused parameters - some I have tried fixing, some I have marked with comments. In all cases, I have attached TODO comments for easier review.
Any AI-generated or inspirited docstrigs are tagged with a note that discloses this.
Updated docs and formatting for stack.py, combine.py amd catalog.py
This is in continuation from PR #229 as agreed with @gbrammer .
Specifically:
added missing / completed incomplete docstrings using AI tools
adressed some unused parameters (as this is a part of docs)
went through formatting using black.
In
stack.py, one ambiguitie is marked with a TODO comment (optimal_extractmethod).in
combine.pythe docs I made might be overkill for the small methods inSIP_WCSMapclass - I chose to be consistent with rest of the code, but that might be too much in this case - since I know this will be reviewed I leave it for evaluation.In
catalog.py, I left a few TODO comments around some parameters that might need more attention. I have made docstrings for all the wrappers forquery_tap_catalog- If you would rather have the docstrings reference to thequery_tap_cataloginstead to make things more compact please let me know - I can easily change this.In
fitting.pyI have adressed a handfull of unused parameters - some I have tried fixing, some I have marked with comments. In all cases, I have attached TODO comments for easier review.Any AI-generated or inspirited docstrigs are tagged with a note that discloses this.
All tests pass.