Updated and expanded docstrings for the following functions in the Bo… #1
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…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.
Description
This pull request is to address ...
Fixes #