Skip to content

Commit e2bcd62

Browse files
committed
Reword the msgid documentation to make it terser
1 parent 9b6aabb commit e2bcd62

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

Doc/reference/ldap.rst

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -329,13 +329,12 @@ The module defines the following exceptions:
329329
is set to a truncated form of the name provided or alias dereferenced
330330
for the lowest entry (object or alias) that was matched.
331331

332-
For use in asynchronous operations an optional field :py:const:`msg_id` is
333-
also set in the dictionary in cases where the exception can be associated
334-
with a request. This can be used in asynchronous code where
335-
:py:meth:`result()` returns an exception that is effectively the result of a
336-
previously started asynchronous operation. For example, this is the case for
337-
asynchronous (:py:meth:`compare()`), where the boolean result is always
338-
raised as an exception (:py:exc:`COMPARE_TRUE` or :py:exc:`COMPARE_FALSE`).
332+
The field :py:const:`msgid` is set in the dictionary where the
333+
exception can be associated with an asynchronous request.
334+
This can be used in asynchronous code where :py:meth:`result()` raises the
335+
result of an operation as an exception. For example, this is the case for
336+
:py:meth:`compare()`, always raises the boolean result as an exception
337+
(:py:exc:`COMPARE_TRUE` or :py:exc:`COMPARE_FALSE`).
339338

340339
Most exceptions from protocol results also carry the :py:attr:`errnum`
341340
attribute.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy