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

Clarify that mkdir_if_not_exists will delete files if the directory exists #6

Open
jwallwork23 opened this issue Sep 11, 2024 · 0 comments
Labels
clarity Something isn't sufficiently clear good first issue Good for newcomers

Comments

@jwallwork23
Copy link
Member

In my opinion, it is not obvious that a function named mkdir_if_not_exists would delete all the files in the directory if it already exists.
https://github.com/erizmr/UM2N/blob/aa0ea6b130dc8eeef945b939c4b1787359e0b0b5/warpmesh/helper/helper.py#L8-L15

It would be a good idea to rename the function, or at least clarify this side-effect in a docstring.

@jwallwork23 jwallwork23 added clarity Something isn't sufficiently clear good first issue Good for newcomers labels Sep 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
clarity Something isn't sufficiently clear good first issue Good for newcomers
Projects
Development

No branches or pull requests

1 participant