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

Document how to flush data folder #21

Open
jd-lara opened this issue Aug 21, 2021 · 3 comments
Open

Document how to flush data folder #21

jd-lara opened this issue Aug 21, 2021 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jd-lara
Copy link
Member

jd-lara commented Aug 21, 2021

We need to add a function to aid in flushing older versions of the data folder that can lead to issues when serializing and de-serializing existing data.

cc. @kdheepak

@claytonpbarrows
Copy link
Member

Is this different from clear_all_serialized_system()?

@jd-lara
Copy link
Member Author

jd-lara commented Aug 22, 2021

We should document these options then because it wasn't clear how to do it.

@jd-lara jd-lara added the documentation Improvements or additions to documentation label Aug 22, 2021
@jd-lara jd-lara changed the title Flush data folder Document how to flush data folder Aug 22, 2021
@daniel-thom
Copy link
Contributor

  1. The function should be exported.
  2. The function should be plural.
  3. Is clear_serialized_systems a better name? In the future someone could add an optional parameter to only remove a specific type of system.
  4. The docstring for build_system could refer to it.

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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants