Document common return values with examples #71046
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
trydydd
changed the title
|
The test |
ansibot
added
affects_2.11
docs
ansibot
added
core_review
imjoseangel
reviewed
Aug 2, 2020
Comment on lines
235
to
236
|
|
||
|
|
Comment on lines
257
to
258
|
|
||
|
|
| stdout_lines | ||
| ```````````` | ||
| When `stdout` is returned, Ansible always provides a list of strings, each containing one item per line from the original output. | ||
|
|
||
|
|
||
|
|
Comment on lines
138
to
164
| "attributes": null, | ||
| "backrefs": false, | ||
| "backup": true, | ||
| "content": null, | ||
| "create": false, | ||
| "delimiter": null, | ||
| "directory_mode": null, | ||
| "firstmatch": false, | ||
| "follow": false, | ||
| "force": null, | ||
| "group": null, | ||
| "insertafter": null, | ||
| "insertbefore": null, | ||
| "line": "foo", | ||
| "mode": null, | ||
| "owner": null, | ||
| "path": "foo.txt", | ||
| "regexp": null, | ||
| "remote_src": null, | ||
| "selevel": null, | ||
| "serole": null, | ||
| "setype": null, | ||
| "seuser": null, | ||
| "src": null, | ||
| "state": "present", | ||
| "unsafe_writes": null, | ||
| "validate": null |
There was a problem hiding this comment.
I think it is better to add a shorter invocation example
There was a problem hiding this comment.
Thank you for the feedback!
acozine
reviewed
Aug 3, 2020
| "after_header": "foo.txt (file attributes)", | ||
| "before_header": "foo.txt (file attributes)" | ||
| } | ||
|
|
||
| Information on differences between the previous and current state. Often a dictionary with entries ``before`` and ``after``, which will then be formatted by the callback plugin to a diff view. |
There was a problem hiding this comment.
I'd put this sentence above the sample codeblock, so all the entries follow the same pattern (Title, description, example).
acozine
removed
the
needs_triage
|
Thanks @terciero for the PR and @imjoseangel for the review! |
samccann
pushed a commit
to samccann/ansible
that referenced
this pull request
Aug 6, 2020
* adding return value examples * shift to console code blocks * cleaning up whitespace and shortening invocation example * reordering diff section (cherry picked from commit 864573a)
acozine
added a commit
that referenced
this pull request
Aug 7, 2020
* Misc typo fixes (#71089) (cherry picked from commit 504ef60) * Add some documentation for the format of meta/runtime.yml (#71035) * Document the format of meta/runtime.yml * Document multiple Ansible versions Clarify difference between deprecation and tombstone fields * add note (cherry picked from commit a9eb8b0) * add note to uninstall older versions of ansible for pip (#71023) * add note to uninstall older versions of ansible for pip * combine with the other PR (cherry picked from commit 72d3d44) * VMware: Inventory scenario guide for hostnames (#71055) Added a scenario guide for ``hostnames`` parameter for vmware_vm_inventory. Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit 0055673) * Document string tests a bit more (#71049) - Explain how `regex` differs from `match` and `search`. - Document `multiline` and `ignorecase`. Signed-off-by: Rick Elrod <rick@elrod.me> (cherry picked from commit 701c638) * docs: Add a note about package requirements for fact gathering (#70796) Fixes: #26148 Signed-off-by: Abhijeet Kasurde <akasurde@redhat.com> (cherry picked from commit a6725d6) * added note about fakeroot (#71018) see #70895 (cherry picked from commit 11a31e9) * Update documentation of httpapi's handle_httperror method for clarity (#70991) (cherry picked from commit a0523e5) * DOCS: add 2.10 collections roadmap (#70975) * draft of 2.10 collections roadmap * incorporates feedback from felixfontein * gundalow and samccann feedback, fix link Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> (cherry picked from commit 9879da8) * updates changelog types; some updates for easier translation (#71027) Co-authored-by: Alicia Cozine <acozine@users.noreply.github.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 4f4436c) * Document common return values with examples (#71046) * adding return value examples * shift to console code blocks * cleaning up whitespace and shortening invocation example * reordering diff section (cherry picked from commit 864573a) * Update intro_getting_started.rst (#71039) Added two additional learning resources in the See also: section- forgot closing backticks (cherry picked from commit 9850915) * Guide users to use ansible-runner (#71063) Update the docs to guide users to use `ansible-runner` instead of using Python API directly. In many use cases, executing Ansible playbooks are sufficient. In those use cases, `ansible-runner` is easier and much stable to use comparing with Python API, but there is no mention of it. (cherry picked from commit 0c855dc) * Porting guides for ansible-base 2.10 and ansible 2.10 (#70891) * Fix changelog link title. * Rename Ansible 2.10 and 2.11 porting guides to Ansible-base porting guides. * Add stub for automatically generated 2.10 porting guide. * Move things that should not be in the ansible-base porting guide to the ansible porting guide. * Apply changes to base porting guides. * Add remark that ansible-base is mainly for developers. * Ansible Base -> Ansible-base * Fix link in base porting guide. * Add generated porting guide. * Use same header signs as antsibull-changelog's RST builder. * Update generated porting guide. (cherry picked from commit 61b36c6) * Update network platform guides with FQCN (#70699) * fqcn all the docs things! (cherry picked from commit 54bee71) * Document how to upgrade to ansible with pip (#70768) Fixes #70348 (cherry picked from commit 5019335) * document how to migrate between collections (#70243) * document how to migrate between collections * Apply suggestions from code review Co-authored-by: John R Barker <john@johnrbarker.com> Co-authored-by: Felix Fontein <felix@fontein.de> (cherry picked from commit 58145df) * remove github link from plugins (#70951) (cherry picked from commit e28b20d) * Add latest rc from ansible-base (#70974) * Add latest rc from ansible-base (cherry picked from commit d62dffa) * Document to_json will convert to ASCII strings by default (#70954) ... as reported in issue #68702 (cherry picked from commit 8c48366) * Update the porting guide for ansible-2.10.0a8 (#71141) (cherry picked from commit 0a9638c) Co-authored-by: Abhijeet Kasurde <akasurde@redhat.com> Co-authored-by: Sloane Hertel <shertel@redhat.com> Co-authored-by: Rick Elrod <rick@elrod.me> Co-authored-by: Brian Coca <bcoca@users.noreply.github.com> Co-authored-by: Nathaniel Case <ncase@redhat.com> Co-authored-by: Alicia Cozine <879121+acozine@users.noreply.github.com> Co-authored-by: Terciero <terciero@users.noreply.github.com> Co-authored-by: Brendon O'Sullivan <49501251+bjosullivan@users.noreply.github.com> Co-authored-by: EthanHur <ethan0311@gmail.com> Co-authored-by: Felix Fontein <felix@fontein.de> Co-authored-by: Baptiste Mille-Mathias <baptiste.millemathias@gmail.com> Co-authored-by: Toshio Kuratomi <a.badger@gmail.com>
zoredache
pushed a commit
to zoredache/ansible
that referenced
this pull request
Aug 10, 2020
* adding return value examples * shift to console code blocks * cleaning up whitespace and shortening invocation example * reordering diff section
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
Related Issue: #65062
Change:
ISSUE TYPE
Resolves #65062