fix: add documentation for the :zip command. fixes #62 #115
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
chrislwade
force-pushed
the
bugfix/zip-command-docs
branch
from
e62943c to
0fe8ec6
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems related to this change, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
From reviewing #62 I discovered the solution for the error mentioned in that issue has been found but not yet documented for future users. This change is intended to begin documenting the special
:zipcommand so future module users do not end up confused why they are getting a Python error from what appears to be a properly configured module usage.Motivation and Context
This fixes the documentation issue discovered in #62.
Breaking Changes
This is a documentation change only, no breaking changes.
How Has This Been Tested?
Documentation change, no testing.