New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Updated and expanded docstrings for the following functions in the BoundingBox module: #15823
base: main
Are you sure you want to change the base?
Conversation
…undingBox module: ModelBoundingBox._validate_shape: Improved documentation for shape validation in intervals, emphasizing valid and invalid input shapes. ModelBoundingBox._validate_sequence: Clarified docstrings regarding order validation, specifying valid options and handling of invalid orders. ModelBoundingBox._validate_iterable: Enhanced documentation on iterable validation, highlighting proper handling of ignored intervals. ModelBoundingBox._valid_index: Expanded and clarified docstrings for valid index validation in different input scenarios. ModelBoundingBox.test__setitem__: Updated docstrings to provide more clarity on setting intervals using keys and indices, including Model Set support. ModelBoundingBox.test__validate_shape: Improved docstrings to better explain shape validation in intervals, including units. ModelBoundingBox.test_prepare_inputs: Expanded and clarified docstrings for preparing inputs with arrays and scalar inputs inside and outside the bounding box. ModelBoundingBox.test_create: Enhanced docstrings to describe the creation test, covering model parameters, bounding boxes, and various input configurations. ModelBoundingBox.test_reduce: Improved docstrings for the reduction test, specifying different scenarios for reducing selector arguments based on model parameters. ModelBoundingBox.test_validate: Updated docstrings to provide more clarity on selector argument validation with different input scenarios. These changes aim to provide more comprehensive and understandable documentation for the respective functions within the BoundingBox module.
Updated and expanded docstrings for the following functions in the Bo…
Thank you for your contribution to Astropy! 🌌 This checklist is meant to remind the package maintainers who will review this pull request of some common things to look for.
|
pre-commit.ci autofix |
for more information, see https://pre-commit.ci
Just a broad general query: Is there an expectation to write comprehensive docs for all tests in astropy? |
No. None of these will be rendered. |
Hey there, I wanted to confirm if there's anything more that needs to be done on my pull request. I'm committed to ensuring the contribution aligns with the project's standards. |
Nothing to be done... In fact, I am not 100% this is necessary. I'll leave it to the judgement of |
ModelBoundingBox._validate_shape:
Improved documentation for shape validation in intervals, emphasizing valid and invalid input shapes.
ModelBoundingBox._validate_sequence:
Clarified docstrings regarding order validation, specifying valid options and handling of invalid orders.
ModelBoundingBox._validate_iterable:
Enhanced documentation on iterable validation, highlighting proper handling of ignored intervals.
ModelBoundingBox._valid_index:
Expanded and clarified docstrings for valid index validation in different input scenarios.
ModelBoundingBox.test__setitem__:
Updated docstrings to provide more clarity on setting intervals using keys and indices, including Model Set support.
ModelBoundingBox.test__validate_shape:
Improved docstrings to better explain shape validation in intervals, including units.
ModelBoundingBox.test_prepare_inputs:
Expanded and clarified docstrings for preparing inputs with arrays and scalar inputs inside and outside the bounding box.
ModelBoundingBox.test_create:
Enhanced docstrings to describe the creation test, covering model parameters, bounding boxes, and various input configurations.
ModelBoundingBox.test_reduce:
Improved docstrings for the reduction test, specifying different scenarios for reducing selector arguments based on model parameters.
ModelBoundingBox.test_validate:
Updated docstrings to provide more clarity on selector argument validation with different input scenarios.
These changes aim to provide more comprehensive and understandable documentation for the respective functions within the BoundingBox module.
Description
This pull request is to address ...
Fixes #