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

Create a poc module for utilities that help with proof-of-concept #1846

Closed
npatki opened this issue Mar 11, 2024 · 0 comments · Fixed by #1853
Closed

Create a poc module for utilities that help with proof-of-concept #1846

npatki opened this issue Mar 11, 2024 · 0 comments · Fixed by #1853
Assignees
Labels
feature request Request for a new feature
Milestone

Comments

@npatki
Copy link
Contributor

npatki commented Mar 11, 2024

Problem Description

A few of the newer functions in the utils module are specifically being added to allow users to easily perform a proof-of-concept with a multi-table dataset. It would be nice to group these functions in a sub-module to keep them organized and communicate exactly what these functions are needed for.

Expected behavior

Create a submodule called poc inside of utils. We will expect users to import the poc submodule specifically in order to access the functions.

from utils import poc

valid_data = poc.drop_unknown_references(metadata, data)

The relevant functions inside poc should be:

Note that these function should not be accessible through utils alone -- only through poc. It is also ok if users want to import these functions alone:

from utils.poc import drop_unknown_references
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request Request for a new feature
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants