Update copy.py #56370
Merged
Update copy.py #56370
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
<!--- Updated the description of the 'dest' parameter to specify that a file will be created if path is invalid if 'content' parameter is used instead of 'src' parameter --> +label: docsite_pr
ansibot
added
affects_2.9
ptux
reviewed
May 14, 2019
lib/ansible/modules/files/copy.py
Outdated
| @@ -46,6 +46,7 @@ | |||
| - If C(dest) is a non-existent path and if either C(dest) ends with "/" or C(src) is a directory, C(dest) is created. | |||
| - If I(dest) is a relative path, the starting directory is determined by the remote host. | |||
| - If C(src) and C(dest) are files, the parent directory of C(dest) is not created and the task fails if it does not already exist. | |||
| - If C(content) is used and C(dest) is a file, file is created if it does not already exist | |||
There was a problem hiding this comment.
Could you add . to the end of the sentence, please.
|
It will be appreciated if you show the evidence(playbook and output) for the change. |
ansibot
removed
the
needs_triage
ansibot
added
the
stale_ci
samccann
added
the
waiting_on_contributor
|
@ptux Let me know if more evidence is needed |
ansibot
removed
the
stale_ci
sivel
requested changes
Jun 28, 2019
lib/ansible/modules/files/copy.py
Outdated
| @@ -46,6 +46,7 @@ | |||
| - If C(dest) is a non-existent path and if either C(dest) ends with "/" or C(src) is a directory, C(dest) is created. | |||
| - If I(dest) is a relative path, the starting directory is determined by the remote host. | |||
| - If C(src) and C(dest) are files, the parent directory of C(dest) is not created and the task fails if it does not already exist. | |||
| - If C(content) is used and C(dest) is a file, file is created if it does not already exist. | |||
There was a problem hiding this comment.
In my opinion, this is documenting obvious functionality of the module. As such, I don't find this added documentation useful.
Perhaps additional clarification can be added to the description of the module to indicate that it does not require a file.
There was a problem hiding this comment.
I made a change to the content description now, @sivel please review
ansibot
added
needs_revision
ansibot
added
the
stale_ci
ansibot
removed
small_patch
stale_ci
acozine
removed
the
waiting_on_contributor
ansibot
added
the
waiting_on_contributor
acozine
removed
the
waiting_on_contributor
ansibot
added
the
waiting_on_contributor
dagwieers
added
the
docsite_pr
sivel
removed
the
waiting_on_contributor
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.
+label: docsite_pr
SUMMARY
Updated the description of the 'dest' parameter to specify that a file will be created if path is invalid but 'content' parameter is used instead of 'src' parameter
ISSUE TYPE
COMPONENT NAME
copy
ADDITIONAL INFORMATION