diff options
author | Jason R. Coombs <jaraco@jaraco.com> | 2014-10-19 12:55:43 +0100 |
---|---|---|
committer | Jason R. Coombs <jaraco@jaraco.com> | 2014-10-19 12:55:43 +0100 |
commit | 7ac30f9142fc7a5b8116ffe7e1ee0a7d2350a2e5 (patch) | |
tree | 56e04bbb07093e70075b85976c64472b3a807a15 | |
parent | fb855e9b08c8af38b898be071c0cb26fdc78ff6b (diff) | |
download | python-setuptools-bitbucket-7ac30f9142fc7a5b8116ffe7e1ee0a7d2350a2e5.tar.gz |
Update docstring to be imperative and incorporate comment. Omit lessons about string literals.
-rw-r--r-- | setuptools/windows_support.py | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/setuptools/windows_support.py b/setuptools/windows_support.py index fd373009..8da71243 100644 --- a/setuptools/windows_support.py +++ b/setuptools/windows_support.py @@ -1,13 +1,13 @@ -# From http://stackoverflow.com/questions/19622133/python-set-hide-attribute-on-folders-in-windows-os - import ctypes def hide_file(path): - """Sets the hidden attribute on a file or directory + """ + Set the hidden attribute on a file or directory. + + From http://stackoverflow.com/questions/19622133/ - `path` must be unicode; be careful that you escape backslashes or use raw - string literals - e.g.: `u'G:\\Dir\\folder1'` or `ur'G:\Dir\folder1'`. + `path` must be text. """ SetFileAttributesW = ctypes.windll.kernel32.SetFileAttributesW |