-
Notifications
You must be signed in to change notification settings - Fork 23.8k
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 unarchive.py - Further clarify extra_opts #58102
Conversation
##### 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
|
The test
The test
The test
The test
The test
The test
The test
The test
The test
|
This is what I get for editing the docs in github directly. I'll have to try this locally. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@jagibson, I think accepting these two suggestions will get CI passing.
@jagibson re-read the PR and example - I misunderstood what you were saying at first. Do the updated suggestions express your meaning correctly? |
@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>
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.
Maybe it was a fluke that it failed before.
This looks good, thanks @jagibson. |
* 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)
* 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)
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