]> granicus.if.org Git - python/commitdiff
Fix markup errors from r59857 and clarify key.__enter__/__exit__ docs
authorGeorg Brandl <georg@python.org>
Tue, 8 Jan 2008 16:18:26 +0000 (16:18 +0000)
committerGeorg Brandl <georg@python.org>
Tue, 8 Jan 2008 16:18:26 +0000 (16:18 +0000)
Doc/library/_winreg.rst

index 2544b5a60c6ff1ec3d2df49243dc2b80f82f7731..6aed8cbdaae2187c86fd066a2e91d83aeb4d18c7 100644 (file)
@@ -136,11 +136,11 @@ This module offers the following functions:
 .. function:: ExpandEnvironmentStrings(unicode)
 
    Expands environment strings %NAME% in unicode string like const:`REG_EXPAND_SZ`::
-   
-   >>> ExpandEnvironmentStrings(u"%windir%")
-   u"C:\\Windows"
-   
-   .. versionadded: 2.6
+
+      >>> ExpandEnvironmentStrings(u"%windir%")
+      u"C:\\Windows"
+
+   .. versionadded:: 2.6
 
 
 .. function:: FlushKey(key)
@@ -429,10 +429,15 @@ handle, and also disconnect the Windows handle from the handle object.
    underlying Win32 handle to exist beyond the lifetime  of the handle object.
 
 .. method:: PyHKEY.__enter__()
-.. method:: PyHKEY.__exit__(*exc_info)
-   
-   The HKEY object implements __enter__ and __exit__ and thus supports the 
-   context protocol for the with statement.
-   
-   .. versionadded: 2.6
+            PyHKEY.__exit__(\*exc_info)
+
+   The HKEY object implements :meth:`__enter__` and :meth:`__exit__` and thus
+   supports the context protocol for the :keyword:`with` statement::
+
+      with OpenKey(HKEY_LOCAL_MACHINE, "foo") as key:
+          # ... work with key ...
+
+   will automatically close *key* when control leaves the :keyword:`with` block.
+
+   .. versionadded:: 2.6