Update unarchive.py - Further clarify extra_opts #58102
Merged
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
##### SUMMARY Update the description in the options to help assist with what the module is looking for in the extra_opts. ansible#31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options. ##### ISSUE TYPE - Docs Pull Request +label: docsite_pr
|
The test |
ansibot
added
affects_2.9
ansibot
removed
the
ci_verified
|
The test The test The test The test The test The test The test The test The test |
bcoca
removed
the
needs_triage
samdoran
added
the
ci_verified
|
This is what I get for editing the docs in github directly. I'll have to try this locally. |
ansibot
added
the
stale_ci
|
@jagibson re-read the PR and example - I misunderstood what you were saying at first. Do the updated suggestions express your meaning correctly? |
acozine
added
the
needs_info
ansibot
removed
the
needs_info
ansibot
added
the
needs_info
dagwieers
added
the
docsite_pr
|
@jagibson This pullrequest is waiting for your response. Please respond or the pullrequest will be closed. |
Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
ansibot
removed
ci_verified
ansibot
removed
the
stale_ci
Fix for multi-line Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com>
|
The test The test The test The test The test The test |
ERROR: lib/ansible/modules/files/unarchive.py:0:0: doc-default-does-not-match-spec: Argument 'validate_certs' in argument_spec defines default as (True) but documentation defines default as (False) (75%) Changed doc to be "True" which matches the code.
ansibot
removed
the
needs_revision
Maybe it was a fluke that it failed before.
ansibot
added
the
stale_ci
|
This looks good, thanks @jagibson. |
ansibot
removed
the
stale_ci
acozine
pushed a commit
to acozine/ansible
that referenced
this pull request
Oct 15, 2019
* Update unarchive.py - Further clarify extra_opts Update the description in the options to help assist with what the module is looking for in the extra_opts. ansible#31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options. Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit e967060)
acozine
added a commit
that referenced
this pull request
Oct 16, 2019
* Update sros_config.py (#63132) (cherry picked from commit b3deab4) * add note about collection links (#63346) (cherry picked from commit bdd0fac) * Nosh module documentation update (#63303) * detail the 'status' dictionary * did not add individual descriptions, see nosh documentation for those * sample: False not being rendered unless 'False' is quoted (cherry picked from commit df28378) * Move galaxy appendix info to a new Galaxy section (#63356) * start galaxy docs restructure * shared snippets in txt files * moved all content to galaxy section (cherry picked from commit ae265bc) * Enter should be Italics as it is a menu option (#63441) (cherry picked from commit 7a8c909) * ini_file: remove incorrect documentation (#63394) (cherry picked from commit ab249a4) * Changed with_items to loop in VMware example (#63022) (cherry picked from commit 876a2d5) * ovirt update fetch_nested param doc (#63191) (cherry picked from commit 0beab6b) * Update 'delete' parameter description in synchronize module (#63450) Co-Authored-By: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit da46800) * Update unarchive.py - Further clarify extra_opts (#58102) Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options. Co-Authored-By: Alicia Cozine <879121+acozine@users.noreply.github.com> (cherry picked from commit e967060) * ovirt_vm add warning about next run configuration (#63458) (cherry picked from commit 16e49fd) * Fix doc - porting_guide_2.8 value example (#63493) (cherry picked from commit e0f67b5) * Fix warnings for ufw examples (#63505) (cherry picked from commit e4eea05)
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.
SUMMARY
Update the description in the options to help assist with what the module is looking for in the extra_opts. #31873 alone is not enough since if you are not familiar with the option given in the example it may not be obvious that both elements are part of the same option instead of being two different options.
ISSUE TYPE
+label: docsite_pr
SUMMARY
Further clarifies #31873.
Also the Ansible output is not clear what the error is if you format the extra_opts incorrectly (see below)
ISSUE TYPE
COMPONENT NAME
unarchive.py module
ADDITIONAL INFORMATION