From 79317164397f4d327676a3e4c03279e7924034b9 Mon Sep 17 00:00:00 2001
From: Kovid Goyal <kovid@kovidgoyal.net>
Date: Wed, 25 Jan 2012 12:27:13 +0530
Subject: [PATCH] ...

---
 src/calibre/constants.py | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/src/calibre/constants.py b/src/calibre/constants.py
index 902dc057df..30f4df204a 100644
--- a/src/calibre/constants.py
+++ b/src/calibre/constants.py
@@ -172,6 +172,11 @@ def get_unicode_windows_env_var(name):
     return buf.value
 
 def get_windows_username():
+    '''
+    Return the user name of the currently loggen in user as a unicode string.
+    Note that usernames on windows are case insensitive, the acse of the value
+    returned depends on what the user typed into the login box at login time.
+    '''
     import ctypes
     try:
         advapi32 = ctypes.windll.advapi32