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

Point to Unzip/tar from Decompress docs and errors #200

Merged
merged 2 commits into from
Jul 30, 2020

Conversation

leouieda
Copy link
Member

If given a .zip or .tar archive, Decompress will now tell users to
use Unzip and Untar instead. This clears up the confusion around why
Decompress doesn't work with zip files. Add a pointer to the
docstring as well.

Fixes #184

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

If given a `.zip` or `.tar` archive, `Decompress` will now tell users to
use `Unzip` and `Untar` instead. This clears up the confusion around why
`Decompress` doesn't work with zip files. Add a pointer to the
docstring as well.
@leouieda leouieda added the enhancement Idea or request for a new feature label Jul 30, 2020
@leouieda leouieda merged commit 995af5a into master Jul 30, 2020
@leouieda leouieda deleted the decompress_message branch July 30, 2020 15:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Idea or request for a new feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Point users to Unzip/Untar in Decompress error messages
1 participant