Merge pull request #30360 from jfindlay/remove_doc

file.remove, file.absent: mention recursive dir removal
This commit is contained in:
Mike Place 2016-01-14 10:30:25 -07:00
commit b61cb7a238
2 changed files with 3 additions and 2 deletions

View file

@ -3088,7 +3088,8 @@ def rmdir(path):
def remove(path):
'''
Remove the named file
Remove the named file. If a directory is supplied, it will be recursively
deleted.
CLI Example:

View file

@ -962,7 +962,7 @@ def absent(name):
'''
Make sure that the named file or directory is absent. If it exists, it will
be deleted. This will work to reverse any of the functions in the file
state module.
state module. If a directory is supplied, it will be recursively deleted.
name
The path which should be deleted