Rename wb-manager add --uncompress-wacz to --unpack-wacz and add docs - Githubissues

webrecorder / pywb

Core Python Web Archiving Toolkit for replay and recording of web archives

https://pypi.python.org/pypi/pywb

GNU General Public License v3.0

1.41k stars 217 forks source link

Rename wb-manager add --uncompress-wacz to --unpack-wacz and add docs #900

Closed tw4l closed 7 months ago

tw4l commented 7 months ago

Description

Renames the new wb-manager add --uncompress-wacz option to --unpack-wacz.
Add documentation as well as CLI help text for new flag.

Related to https://github.com/webrecorder/pywb/issues/799

Motivation and Context

The new flag name is both more accurate and easier to type.

Also, existing features should be documented, especially if people are likely to use them!

Screenshots (if appropriate):

Types of changes

[ ] Replay fix (fixes a replay specific issue)
[ ] Bug fix (non-breaking change which fixes an issue)
[ ] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to change)
[x] Renaming of existing feature prior to first release it's included in

Checklist:

[ ] My change requires a change to the documentation.
[x] I have updated the documentation accordingly.
[x] I have added or updated tests to cover my changes.
[x] All new and existing tests passed.

tw4l commented 7 months ago

@ikreymer - arg renaming (lmk what you think) and docs update for pywb 2.8 prior to release tomorrow :)

tw4l commented 7 months ago

Closing because I renamed the branch, will open another PR shortly.