ansible-collections/community.general
1
0
Fork 0
mirror of https://github.com/ansible-collections/community.general.git synced 2025-10-04 23:44:00 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 8

Pull documentation of ansible.module_utils.basic from (improved) doc strings. (#48416)

Browse source
This commit is contained in:
Andreas Krüger 2018-12-10 16:17:15 +01:00 • committed by Alicia Cozine
commit 18bf48cec2
6 changed files with 47 additions and 66 deletions
Download patch file Download diff file Expand all files Collapse all files

14
lib/ansible/module_utils/common/file.py
View file

@ -63,12 +63,22 @@ _DEFAULT_PERM = 0o0666 # default file permission bits
def is_executable(path):
'''is the given path executable?
# This function's signature needs to be repeated
# as the first line of its docstring.
# This method is reused by the basic module,
# the repetion helps the basic module's html documentation come out right.
# http://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html#confval-autodoc_docstring_signature
'''is_executable(path)
is the given path executable?
:arg path: The path of the file to check.
Limitations:
* Does not account for FSACLs.
* Most times we really want to know "Can the current user execute this
file" This function does not tell us that, only if an execute bit is set.
file". This function does not tell us that, only if any execute bit is set.
'''
# These are all bitfields so first bitwise-or all the permissions we're
# looking for, then bitwise-and with the file's mode to determine if any