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

_save_struct_data seems to be unused #27

Open
pmeier opened this issue Oct 3, 2021 · 3 comments
Open

_save_struct_data seems to be unused #27

pmeier opened this issue Oct 3, 2021 · 3 comments

Comments

@pmeier
Copy link

pmeier commented Oct 3, 2021

def _save_struct_data(df: pd.DataFrame, fname: PathLike):

Grepping the repository reveals no usage. Given that it seems to be an internal functionality, maybe it can be removed?

@a-ws-m
Copy link
Owner

a-ws-m commented Oct 14, 2021

A good spot -- that function is used for serializing data so that it can be included in this repository and downloaded using unlocknn.download.load_data. At the time I thought it ought to be a private function because it would only really be used for adding more data to the repo (i.e. during development), but I realise that thinking was flawed. I'll make it a public function.

a-ws-m added a commit that referenced this issue Oct 14, 2021
@pmeier
Copy link
Author

pmeier commented Oct 15, 2021

Although 7c45497 made it public, it is not included in the documentation yet.

a-ws-m added a commit that referenced this issue Oct 21, 2021
@a-ws-m
Copy link
Owner

a-ws-m commented Oct 22, 2021

It's now added here alongside instructions for adding one's own data.

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

No branches or pull requests

2 participants