Commit7dd5904

committed

Revise and update rmtree docstrings and comments

1 parent0b88012 commit7dd5904Copy full SHA for 7dd5904

File tree

-5

lines changed

-5

lines changed

Lines changed: 6 additions & 5 deletions

Original file line number	Diff line number	Diff line change
`@@ -170,17 +170,18 @@ def patch_env(name: str, value: str) -> Generator[None, None, None]:`
`170`	`170`
`171`	`171`
`172`	`172`	`defrmtree(path:PathLike)->None:`
`173`		`-"""Remove the given recursively.`
	`173`	`+"""Remove the givendirectory treerecursively.`
`174`	`174`
`175`		`- :note:we use shutilrmtree but adjust its behaviour to see whether files that`
`176`		`- couldn't be deleted are read-only. Windows will not remove them in that case"""`
	`175`	+ :note:We use:func:`shutil.rmtree` but adjust its behaviour to see whether files that
	`176`	`+ couldn't be deleted are read-only. Windows will not remove them in that case."""`
`177`	`177`
`178`	`178`	`defhandler(function:Callable,path:PathLike,_excinfo:Any)->None:`
`179`		`-# Is the error an access error ?`
	`179`	+"""Callback for :func:`shutil.rmtree`. Works either as ``onexc`` or ``onerror``."""
	`180`	`+# Is the error an access error?`
`180`	`181`	`os.chmod(path,stat.S_IWUSR)`
`181`	`182`
`182`	`183`	`try:`
`183`		`-function(path)# Will scream if still not possible to delete.`
	`184`	`+function(path)`
`184`	`185`	`exceptPermissionErrorasex:`
`185`	`186`	`ifHIDE_WINDOWS_KNOWN_ERRORS:`
`186`	`187`	`fromunittestimportSkipTest`

Comments

(0)