Skip to content

Commit 4d385d3

Browse files
committed
Adjust wording
- All fields are optional and more fields may be added in the future - desc might not be English. It comes from ldap_err2string - info is server-specific - there is errno, no errnum
1 parent 6a1fc4d commit 4d385d3

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Doc/reference/ldap.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -463,13 +463,15 @@ The module defines the following exceptions:
463463
is detected.
464464

465465
The exceptions are accompanied by a dictionary with additional information.
466-
The following fields are set in the dictionary if the relevant information
467-
is available:
466+
All fields are optional and more fields may be added in the future.
467+
Currently, ``python-ldap`` may set the following fields:
468468

469-
* ``'desc'``: string giving an English description of the error class.
469+
* ``'desc'``: string giving a description of the error class, as provided
470+
by openLDAP's ``ldap_err2string``.
470471
* ``'info'``: string containing more information that the server may
471-
have sent.
472-
* ``'errnum'``: numeric error code.
472+
have sent. The value is server-specific: for example, the OpenLDAP server
473+
may send different info messages than Active Directory or 389-DS.
474+
* ``'errno'``: numeric error code.
473475
* ``'matched'``: truncated form of the name provided or alias.
474476
dereferenced for the lowest entry (object or alias) that was matched.
475477
* ``'msgid'``: ID of the matching asynchronous request.

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