Skip to content
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 Bo… #1

Merged
merged 1 commit into from
Jan 6, 2024

Conversation

anivenk25
Copy link
Owner

…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 #

  • By checking this box, the PR author has requested that maintainers do NOT use the "Squash and Merge" button. Maintainers should respect this when possible; however, the final decision is at the discretion of the maintainer that merges the PR.

…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.
@anivenk25 anivenk25 merged commit 31b88e7 into main Jan 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant