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

Typing returned config #7

Open
1 task
lewisjared opened this issue Mar 12, 2024 · 0 comments
Open
1 task

Typing returned config #7

lewisjared opened this issue Mar 12, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@lewisjared
Copy link

The problem

As a developer I want to be able to use the type hints for configuration in notebooks. This improves the developer experience and may make code easier to refactor in future.

When using pydoit-nb I've started using the following pattern to manually type configuration returned from get_config_for_step_id which is useful.

config_step: RunConfig = get_config_for_step_id(
    config=config, step=step, step_config_id=step_config_id
) 

If typing the return value of get_config_for_step_id is in the too hard basket the above should be the documented pattern.

Definition of "done"

  • Type the return value of get_config_for_step_id if possible
@lewisjared lewisjared added documentation Improvements or additions to documentation enhancement New feature or request labels Mar 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant