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 | 3d532f52850f0c860f0031519a25231797320976 (patch) | |
tree | 2836f3cefdf567d04b137abd73353e35711cb50c | |
parent | 5c68f3db41766e24d5fe6f7adbfd713bc83786a3 (diff) | |
download | external_python_setuptools-3d532f52850f0c860f0031519a25231797320976.tar.gz external_python_setuptools-3d532f52850f0c860f0031519a25231797320976.tar.bz2 external_python_setuptools-3d532f52850f0c860f0031519a25231797320976.zip |
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 |