Skip to content

Commit

Permalink
Reword the msgid documentation to make it terser
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Viktorin committed Jun 5, 2020
1 parent 9b6aabb commit e2bcd62
Showing 1 changed file with 6 additions and 7 deletions.
13 changes: 6 additions & 7 deletions Doc/reference/ldap.rst
Original file line number Diff line number Diff line change
Expand Up @@ -329,13 +329,12 @@ The module defines the following exceptions:
is set to a truncated form of the name provided or alias dereferenced
for the lowest entry (object or alias) that was matched.

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

Most exceptions from protocol results also carry the :py:attr:`errnum`
attribute.
Expand Down

0 comments on commit e2bcd62

Please sign in to comment.