[Python-checkins] CVS: python/dist/src/PC winreg.c,1.2,1.3

[Mark Hammond]

Update of /cvsroot/python/python/dist/src/PC
In directory slayer.i.sourceforge.net:/tmp/cvs-serv26869

Modified Files:
	winreg.c 
Log Message:
Cleanup a few docstrings.

Index: winreg.c
===================================================================
RCS file: /cvsroot/python/python/dist/src/PC/winreg.c,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -r1.2 -r1.3
*** winreg.c	2000/05/03 23:44:37	1.2
--- winreg.c	2000/06/09 06:01:47	1.3
***************
*** 89,93 ****
  "\n"
  "The return value is the handle of the opened key.\n"
! "If the function fails, an exception is raised.";
  
  static char CreateKey_doc[] =
--- 89,93 ----
  "\n"
  "The return value is the handle of the opened key.\n"
! "If the function fails, an EnvironmentError exception is raised.";
  
  static char CreateKey_doc[] =
***************
*** 114,118 ****
  "\n"
  "If the method succeeds, the entire key, including all of its values,\n"
! "is removed.  If the method fails, and exception is raised.";
  
  static char DeleteValue_doc[] =
--- 114,118 ----
  "\n"
  "If the method succeeds, the entire key, including all of its values,\n"
! "is removed.  If the method fails, an EnvironmentError exception is raised.";
  
  static char DeleteValue_doc[] =
***************
*** 129,134 ****
  "\n"
  "The function retrieves the name of one subkey each time it is called.\n"
! "It is typically called repeatedly until an exception is raised, indicating\n"
! "no more values are available.\n";
  
  static char EnumValue_doc[] =
--- 129,134 ----
  "\n"
  "The function retrieves the name of one subkey each time it is called.\n"
! "It is typically called repeatedly until an EnvironmentError exception is\n"
! "raised, indicating no more values are available.\n";
  
  static char EnumValue_doc[] =
***************
*** 138,143 ****
  "\n"
  "The function retrieves the name of one subkey each time it is called.\n"
! "It is typically called repeatedly, until an exception is raised,\n"
! "indicating no more values.\n"
  "\n"
  "The result is a tuple of 3 items:\n"
--- 138,143 ----
  "\n"
  "The function retrieves the name of one subkey each time it is called.\n"
! "It is typically called repeatedly, until an EnvironmentError exception\n"
! "is raised, indicating no more values.\n"
  "\n"
  "The result is a tuple of 3 items:\n"
***************
*** 161,165 ****
  
  static char LoadKey_doc[] =
! "RegLoadKey(key, sub_key, file_name) - Creates a subkey under the specified key.\n"
  "and stores registration information from a specified file into that subkey.\n"
  "\n"
--- 161,165 ----
  
  static char LoadKey_doc[] =
! "LoadKey(key, sub_key, file_name) - Creates a subkey under the specified key\n"
  "and stores registration information from a specified file into that subkey.\n"
  "\n"
***************
*** 189,193 ****
  "\n"
  "The result is a new handle to the specified key\n"
! "If the function fails, an exception is raised.\n";
  
  static char OpenKeyEx_doc[] =
--- 189,193 ----
  "\n"
  "The result is a new handle to the specified key\n"
! "If the function fails, an EnvironmentError exception is raised.\n";
  
  static char OpenKeyEx_doc[] =
***************
*** 209,213 ****
  "\n"
  "key is an already open key, or any one of the predefined HKEY_* constants.\n"
! "sub_key is a string that holds The name of the subkey with which the value\n"
  " is associated.  If this parameter is None or empty, the function retrieves\n"
  " the value set by the SetValue() method for the key identified by key."
--- 209,213 ----
  "\n"
  "key is an already open key, or any one of the predefined HKEY_* constants.\n"
! "sub_key is a string that holds the name of the subkey with which the value\n"
  " is associated.  If this parameter is None or empty, the function retrieves\n"
  " the value set by the SetValue() method for the key identified by key."
***************
*** 269,274 ****
  "                   to environment variables (for example, %PATH%).\n"
  "  REG_LINK -- A Unicode symbolic link.\n"
! "  REG_MULTI_SZ -- An array of null-terminated strings, terminated by\n"
! "                  two null characters.\n"
  "  REG_NONE -- No defined value type.\n"
  "  REG_RESOURCE_LIST -- A device-driver resource list.\n"
--- 269,275 ----
  "                   to environment variables (for example, %PATH%).\n"
  "  REG_LINK -- A Unicode symbolic link.\n"
! "  REG_MULTI_SZ -- An sequence of null-terminated strings, terminated by\n"
! "                  two null characters.  Note that Python handles this\n"
! "                  termination automatically.\n"
  "  REG_NONE -- No defined value type.\n"
  "  REG_RESOURCE_LIST -- A device-driver resource list.\n"
***************
*** 291,295 ****
  "PyHKEY Object - A Python object, representing a win32 registry key.\n"
  "\n"
! "This object wraps a win32 HANDLE object, automatically closing it when\n"
  "the object is destroyed.  To guarantee cleanup, you can call either\n"
  "the Close() method on the PyHKEY, or the CloseKey() method.\n"
--- 292,296 ----
  "PyHKEY Object - A Python object, representing a win32 registry key.\n"
  "\n"
! "This object wraps a Windows HKEY object, automatically closing it when\n"
  "the object is destroyed.  To guarantee cleanup, you can call either\n"
  "the Close() method on the PyHKEY, or the CloseKey() method.\n"
***************
*** 312,321 ****
  
  static char PyHKEY_Close_doc[] =
! "key.Close() - Closes the underlying Win32 handle.\n"
  "\n"
  "If the handle is already closed, no error is raised.";
  
  static char PyHKEY_Detach_doc[] =
! "int = key.Detach() - Detaches the Win32 handle from the handle object.\n"
  "\n"
  "The result is the value of the handle before it is detached.  If the\n"
--- 313,322 ----
  
  static char PyHKEY_Close_doc[] =
! "key.Close() - Closes the underlying Windows handle.\n"
  "\n"
  "If the handle is already closed, no error is raised.";
  
  static char PyHKEY_Detach_doc[] =
! "int = key.Detach() - Detaches the Windows handle from the handle object.\n"
  "\n"
  "The result is the value of the handle before it is detached.  If the\n"
***************
*** 325,329 ****
  "but the handle is not closed.  You would call this function when you\n"
  "need the underlying win32 handle to exist beyond the lifetime of the\n"
! "handle object.";
  
  
--- 326,331 ----
  "but the handle is not closed.  You would call this function when you\n"
  "need the underlying win32 handle to exist beyond the lifetime of the\n"
! "handle object.\n"
! "On 64 bit windows, the result of this function is a long integer\n";