]> granicus.if.org Git - python/commit
Enhance os.scandir() doc
authorVictor Stinner <victor.stinner@gmail.com>
Sun, 31 Jan 2016 17:36:41 +0000 (18:36 +0100)
committerVictor Stinner <victor.stinner@gmail.com>
Sun, 31 Jan 2016 17:36:41 +0000 (18:36 +0100)
commit5f0c5d92ef4b77f1d8a3610d3bb8022ee71db100
tree6f1e898676eb5eae2456c3e66e4f9f9f00d427cb
parentfe5f6144184729628e81998063b7b8c3ee8943ec
Enhance os.scandir() doc

Issue #26248, patch written by Ben Hoyt:

1) Clarify that the return values of is_dir()/is_file()/etc are cached
   separately for follow_symlinks True and False.
2) Be more specific about when the functions require a system call, and how it
   relates to caching and follow_symlinks.
3) DRY up common stuff between is_dir and is_file by saying "Caching, system
   calls made, and exceptions raised are as per is_dir" in is_file.
4) Tweak to the first paragraph of docs for is_dir/is_file to simplify: assume
   the follow_symlinks=True default, then note the follow_symlinks=False
   non-default case after.
Doc/library/os.rst