Author: cito Date: Wed Dec 30 11:39:40 2015 New Revision: 672 Log: Use consistent indentation in docs
Modified: branches/4.x/docs/pg.txt Modified: branches/4.x/docs/pg.txt ============================================================================== --- branches/4.x/docs/pg.txt Wed Dec 30 10:11:51 2015 (r671) +++ branches/4.x/docs/pg.txt Wed Dec 30 11:39:40 2015 (r672) @@ -488,16 +488,16 @@ .. data:: version, __version__ - constants that give the current version + constants that give the current version .. data:: INV_READ, INV_WRITE - large objects access modes, - used by :meth:`pgobject.locreate` and :meth:`pglarge.open` + large objects access modes, + used by :meth:`pgobject.locreate` and :meth:`pglarge.open` .. data:: SEEK_SET, SEEK_CUR, SEEK_END: - positional flags, used by :meth:`pglarge.seek` + positional flags, used by :meth:`pglarge.seek` pgobject -- The connection object @@ -511,19 +511,19 @@ .. note:: - Some methods give direct access to the connection socket. - *Do not use them unless you really know what you are doing.* - If you prefer disabling them, - set the ``-DNO_DIRECT`` option in the Python setup file. - These methods are specified by the tag [DA]. + Some methods give direct access to the connection socket. + *Do not use them unless you really know what you are doing.* + If you prefer disabling them, + set the ``-DNO_DIRECT`` option in the Python setup file. + These methods are specified by the tag [DA]. .. note:: - Some other methods give access to large objects - (refer to PostgreSQL user manual for more information about these). - If you want to forbid access to these from the module, - set the ``-DNO_LARGE`` option in the Python setup file. - These methods are specified by the tag [LO]. + Some other methods give access to large objects + (refer to PostgreSQL user manual for more information about these). + If you want to forbid access to these from the module, + set the ``-DNO_LARGE`` option in the Python setup file. + These methods are specified by the tag [LO]. query -- execute a SQL command string ------------------------------------- @@ -575,11 +575,11 @@ .. method:: pgobject.reset() - Reset the :mod:`pg` connection + Reset the :mod:`pg` connection - :rtype: None - :raises TypeError: too many (any) arguments - :raises TypeError: invalid connection + :rtype: None + :raises TypeError: too many (any) arguments + :raises TypeError: invalid connection This method resets the current database connection. @@ -588,9 +588,9 @@ .. method:: pgobject.cancel() - :rtype: None - :raises TypeError: too many (any) arguments - :raises TypeError: invalid connection + :rtype: None + :raises TypeError: too many (any) arguments + :raises TypeError: invalid connection This method requests that the server abandon processing of the current SQL command. @@ -600,10 +600,10 @@ .. method:: pgobject.close() - Close the :mod:`pg` connection + Close the :mod:`pg` connection - :rtype: None - :raises TypeError: too many (any) arguments + :rtype: None + :raises TypeError: too many (any) arguments This method closes the database connection. The connection will be closed in any case when the connection is deleted but this @@ -615,12 +615,12 @@ .. method:: pgobject.fileno() - Return the socket used to connect to the database + Return the socket used to connect to the database - :returns: the socket id of the database connection - :rtype: int - :raises TypeError: too many (any) arguments - :raises TypeError: invalid connection + :returns: the socket id of the database connection + :rtype: int + :raises TypeError: too many (any) arguments + :raises TypeError: invalid connection This method returns the underlying socket id used to connect to the database. This is useful for use in select calls, etc. @@ -630,12 +630,12 @@ .. method:: pgobject.getnotify() - Get the last notify from the server + Get the last notify from the server - :returns: last notify from server - :rtype: tuple, None - :raises TypeError: too many parameters - :raises TypeError: invalid connection + :returns: last notify from server + :rtype: tuple, None + :raises TypeError: too many parameters + :raises TypeError: invalid connection This method tries to get a notify from the server (from the SQL statement NOTIFY). If the server returns no notify, the methods returns None. @@ -650,14 +650,14 @@ .. method:: pgobject.inserttable(table, values) - Insert a Python list into a database table + Insert a Python list into a database table - :param str table: the table name - :param list values: list of rows values - :rtype: None - :raises TypeError: invalid connection, bad argument type, or too many arguments - :raises MemoryError: insert buffer could not be allocated - :raises ValueError: unsupported values + :param str table: the table name + :param list values: list of rows values + :rtype: None + :raises TypeError: invalid connection, bad argument type, or too many arguments + :raises MemoryError: insert buffer could not be allocated + :raises ValueError: unsupported values This method allows to *quickly* insert large blocks of data in a table: It inserts the whole values list into the given table. Internally, it @@ -676,11 +676,11 @@ .. method:: pgobject.get_notice_receiver() - Get the current notice receiver + Get the current notice receiver - :returns: the current notice receiver callable - :rtype: callable, None - :raises TypeError: too many (any) arguments + :returns: the current notice receiver callable + :rtype: callable, None + :raises TypeError: too many (any) arguments This method gets the custom notice receiver callback function that has been set with :meth:`pgobject.set_notice_receiver`, or ``None`` if no @@ -688,11 +688,11 @@ .. method:: pgobject.set_notice_receiver(proc) - Set a custom notice receiver + Set a custom notice receiver - :param proc: the custom notice receiver callback function - :rtype: None - :raises TypeError: the specified notice receiver is not callable + :param proc: the custom notice receiver callback function + :rtype: None + :raises TypeError: the specified notice receiver is not callable This method allows setting a custom notice receiver callback function. When a notice or warning message is received from the server, _______________________________________________ PyGreSQL mailing list [email protected] https://mail.vex.net/mailman/listinfo.cgi/pygresql
