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

Consider Which Functions Exposed To User / Top-Level Module #39

Open
AFg6K7h4fhy2 opened this issue Nov 14, 2024 · 1 comment
Open

Consider Which Functions Exposed To User / Top-Level Module #39

AFg6K7h4fhy2 opened this issue Nov 14, 2024 · 1 comment
Assignees
Labels
Low Priority A task that is of lower relative priority. scope Decision-making on the scope of a tool, task, or object. testing Verifying something works as intended.

Comments

@AFg6K7h4fhy2
Copy link
Collaborator

As per this comment #35 (comment), there remains need for discussion on which functions within forecasttools-py are exposed to the user. These choices will guide error messaging and handling.

@AFg6K7h4fhy2 AFg6K7h4fhy2 added testing Verifying something works as intended. scope Decision-making on the scope of a tool, task, or object. labels Nov 14, 2024
@AFg6K7h4fhy2 AFg6K7h4fhy2 self-assigned this Nov 14, 2024
@AFg6K7h4fhy2
Copy link
Collaborator Author

From PR 35, we have DHM's comment:

Beyond the scope of this PR, but once this lands there should be a cleanup PR to remove these validation helpers from the top-level namespace. Even if they're going to be user-exposed, that's too prominent I think.

Pertaining to:

    idata_group = forecasttools.validate_and_get_idata_group(
        idata=idata, group=group
    )
    variable_data = forecasttools.validate_and_get_idata_group_var(
        idata_group=idata_group, group=group, variable=variable
    )
    forecasttools.validate_idata_group_var_dim(
        variable_data=variable_data, dimension=dimension
    )

@AFg6K7h4fhy2 AFg6K7h4fhy2 added the Low Priority A task that is of lower relative priority. label Nov 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Low Priority A task that is of lower relative priority. scope Decision-making on the scope of a tool, task, or object. testing Verifying something works as intended.
Projects
None yet
Development

No branches or pull requests

1 participant