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

Mention in docs that registry files must use POSIX compatible file names #374

Open
leouieda opened this issue Oct 20, 2023 · 0 comments
Open
Labels
documentation Improvements or additions to documentation

Comments

@leouieda
Copy link
Member

Page that contains the error or needs to be improved (paste link): https://www.fatiando.org/pooch/latest/registry-files.html and https://www.fatiando.org/pooch/latest/api/generated/pooch.Pooch.html#pooch.Pooch.load_registry (docstring of Pooch.load_registry)

Description of the problem/suggestion:

As pointed out in #357, the files names in registry files must now escape any special characters or spaces. This was needed so that spaces in file names could be supported in #315. This behavior will break any existing registry files that didn't have escaped quotations (which was a bug since we should have been requiring escaped characters from the start).

We need to add a note to the pages above explaining this requirement and that it was introduced in Pooch 1.7.

@leouieda leouieda added the documentation Improvements or additions to documentation label Oct 20, 2023
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
Projects
None yet
Development

No branches or pull requests

1 participant