Skip to content

Commit

Permalink
white-space cleaning
Browse files Browse the repository at this point in the history
  • Loading branch information
stroeder committed Aug 16, 2017
1 parent dbe5d5e commit 1ca1ab8
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 26 deletions.
4 changes: 2 additions & 2 deletions Doc/ldap-dn.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: ldap-dn.rst,v 1.9 2017/08/16 12:00:39 stroeder Exp $
.. % $Id: ldap-dn.rst,v 1.10 2017/08/16 12:03:33 stroeder Exp $
:py:mod:`ldap.dn` LDAP Distinguished Name handling
Expand Down Expand Up @@ -75,7 +75,7 @@ The :mod:`ldap.dn` module defines the following functions:

.. function:: is_dn(dn[, flags=0]) -> boolean

This function checks whether *dn* is a valid LDAP distinguished name by
This function checks whether *dn* is a valid LDAP distinguished name by
passing it to function :func:`str2dn`.


Expand Down
22 changes: 11 additions & 11 deletions Doc/ldap-modlist.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: ldap-modlist.rst,v 1.5 2016/03/03 17:06:10 stroeder Exp $
.. % $Id: ldap-modlist.rst,v 1.6 2017/08/16 12:03:33 stroeder Exp $
:py:mod:`ldap.modlist` Generate modify lists
Expand Down Expand Up @@ -27,17 +27,17 @@ The :mod:`ldap.modlist` module defines the following functions:

This function builds a list suitable for passing it directly as argument
*modlist* to method :py:meth:`ldap.ldapobject.LDAPObject.modify` or
its synchronous counterpart :py:meth:`ldap.ldapobject.LDAPObject.modify_s`.
its synchronous counterpart :py:meth:`ldap.ldapobject.LDAPObject.modify_s`.

Roughly when applying the resulting modify list to an entry
holding the data *old_entry* it will be modified in such a way that the entry
holds *new_entry* after the modify operation. It is handy in situations when it
is impossible to track user changes to an entry's data or for synchronizing
operations.

*old_entry* and *new_entry* are dictionaries like returned when
receiving search results.

*ignore_attr_types* is a list of attribute type
names which shall be ignored completely. These attribute types will not appear
in the result at all.
Expand All @@ -53,10 +53,10 @@ The :mod:`ldap.modlist` module defines the following functions:
unnecessary changes (e.g. case of attribute type names in DNs).

.. note::
Replacing attribute values is always done with a
:py:const:`ldap.MOD_DELETE`/:py:const:`ldap.MOD_ADD` pair instead of
:py:const:`ldap.MOD_REPLACE` to work-around potential issues with
attributes for which no EQUALITY matching rule are defined in the
server's subschema. This works correctly in most situations but
rarely fails with some LDAP servers implementing (schema) checks on
Replacing attribute values is always done with a
:py:const:`ldap.MOD_DELETE`/:py:const:`ldap.MOD_ADD` pair instead of
:py:const:`ldap.MOD_REPLACE` to work-around potential issues with
attributes for which no EQUALITY matching rule are defined in the
server's subschema. This works correctly in most situations but
rarely fails with some LDAP servers implementing (schema) checks on
transient state entry during processing the modify operation.
11 changes: 4 additions & 7 deletions Doc/ldap.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: ldap.rst,v 1.37 2017/08/16 11:47:11 stroeder Exp $
.. % $Id: ldap.rst,v 1.38 2017/08/16 12:03:33 stroeder Exp $
********************************************
:py:mod:`ldap` LDAP library interface module
Expand Down Expand Up @@ -261,9 +261,7 @@ This constants are used for DN-parsing functions found in
sub-module :py:mod:`ldap.dn`.

.. seealso::

:manpage:`ldap_str2dn{3}`

`ldap_str2dn(3) <https://www.openldap.org/software/man.cgi?query=ldap_str2dn&sektion=3>`_

.. py:data:: DN_FORMAT_LDAP
Expand Down Expand Up @@ -569,8 +567,8 @@ LDAPObject classes
Instances of :py:class:`LDAPObject` are returned by :py:func:`initialize()`
and :py:func:`open()` (deprecated). The connection is automatically unbound
and closed when the LDAP object is deleted.
Internally :py:class:`LDAPObject` is set to :py:class:`SimpleLDAPObject`

Internally :py:class:`LDAPObject` is set to :py:class:`SimpleLDAPObject`
by default.

.. py:class:: SimpleLDAPObject(uri [, trace_level=0 [, trace_file=sys.stdout [, trace_stack_limit=5]]])
Expand Down Expand Up @@ -1012,7 +1010,6 @@ and wait for and return with the server's result, or with
:rfc:`2830` - Lightweight Directory Access Protocol (v3): Extension for Transport Layer Security



.. py:method:: LDAPObject.unbind() -> int
.. py:method:: LDAPObject.unbind_s() -> None
Expand Down
4 changes: 2 additions & 2 deletions Doc/ldapurl.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: ldapurl.rst,v 1.11 2017/08/16 11:24:37 stroeder Exp $
.. % $Id: ldapurl.rst,v 1.12 2017/08/16 12:03:33 stroeder Exp $
###################################
:py:mod:`ldapurl` LDAP URL handling
Expand Down Expand Up @@ -65,7 +65,7 @@ LDAP URLs

A :py:class:`LDAPUrl` object represents a complete LDAP URL.

.. autoclass:: ldapurl.LDAPUrl
.. autoclass:: ldapurl.LDAPUrl
:members:


Expand Down
4 changes: 2 additions & 2 deletions Doc/ldif.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: ldif.rst,v 1.10 2017/08/16 11:24:37 stroeder Exp $
.. % $Id: ldif.rst,v 1.11 2017/08/16 12:03:33 stroeder Exp $
#####################################
:mod:`ldif` LDIF parser and generator
Expand Down Expand Up @@ -69,7 +69,7 @@ with :mod:`ldif` module, skip some entries and write the result to stdout. ::
import sys
from ldif import LDIFParser,LDIFWriter

SKIP_DN = ["uid=foo,ou=People,dc=example,dc=com",
SKIP_DN = ["uid=foo,ou=People,dc=example,dc=com",
"uid=bar,ou=People,dc=example,dc=com"]

class MyLDIF(LDIFParser):
Expand Down
4 changes: 2 additions & 2 deletions Doc/slapdtest.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. % $Id: slapdtest.rst,v 1.2 2017/08/16 11:25:07 stroeder Exp $
.. % $Id: slapdtest.rst,v 1.3 2017/08/16 12:03:33 stroeder Exp $
#####################################
:mod:`slapdtest` Spawning test instances of OpenLDAP's slapd server
Expand All @@ -9,7 +9,7 @@
.. moduleauthor:: python-ldap project (see https://www.python-ldap.org/)


The module is used for testing python-ldap itself but can be used for
The module is used for testing python-ldap itself but can be used for
automatically testing any OpenLDAP-based configuration setup.

This module is pure Python and does not rely on any non-standard modules.
Expand Down

0 comments on commit 1ca1ab8

Please sign in to comment.