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

Improve cube API default values, typing, docstrings #417

Open
lr4d opened this issue Feb 18, 2021 · 0 comments
Open

Improve cube API default values, typing, docstrings #417

lr4d opened this issue Feb 18, 2021 · 0 comments

Comments

@lr4d
Copy link
Collaborator

lr4d commented Feb 18, 2021

Problem description

Currently the expected input for cube functions is not very clear, as a first-time user.

For example, for the function

def update_cube_from_bag(
we don't define the expected type for remove_conditions (which downstream appears to be Union[None, Condition, Iterable[Condition], Conjunction]). And we type ktk_cube_dataset_ids as Optional[Iterable[str]] but we don't set any default value (which apparently should be "all").

Also, it's not really clear what a " Ktk_cube dataset IDs " means. Is this the same thing as a kartothek dataset UUID ?

This is just a single example. I think there's room for improvement here without the need for major breaking changes.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

1 participant