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

Update GitHub default branch name for version_dev argument #211

Open
santisoler opened this issue Oct 20, 2020 · 1 comment
Open

Update GitHub default branch name for version_dev argument #211

santisoler opened this issue Oct 20, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement Idea or request for a new feature

Comments

@santisoler
Copy link
Member

Description of the desired feature

After GitHub changed the default branch name from master to main, we should update Pooch docstrings to include main as one of the best choices for the version_dev argument, like in:

pooch/pooch/core.py

Lines 282 to 285 in 1f60c6f

version_dev : str
The name used for the development version of a project. If your data is
hosted on Github (and *base_url* is a Github raw link), then
``"master"`` is a good choice (default). Ignored if *version* is None.

We could deprecate plan to change the default value for version_dev to main after Pooch v2.0.0 and add a Deprecation Warning meanwhile.

Are you willing to help implement and maintain this feature? Yes, but I would let anyone to tackle it if they want!

@leouieda leouieda added documentation Improvements or additions to documentation enhancement Idea or request for a new feature labels Nov 9, 2020
@santisoler
Copy link
Member Author

Since "master" is the default value for the version_dev parameter in pooch.create, changing it to "main" would break backward compatibility. I think this issue should be targeted for next major release of Pooch.

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 enhancement Idea or request for a new feature
Projects
None yet
Development

No branches or pull requests

2 participants