Changeset 762 for trunk/docs


Ignore:
Timestamp:
Jan 17, 2016, 11:32:18 AM (3 years ago)
Author:
cito
Message:

Docs and 100% test coverage for NotificationHandler?

Location:
trunk/docs/contents
Files:
3 edited

Legend:

Unmodified
Added
Removed
  • trunk/docs/contents/changelog.rst

    r748 r762  
    5757- Fix notification handler (Thanks Patrick TJ McPhee).
    5858- Fix a small issue with large objects.
     59- Minor improvements of the NotificationHandler.
     60- Converted documentation to Sphinx and added many missing parts.
    5961- The tutorial files have become a chapter in the documentation.
    60 - Greatly improve unit testing, tests run with Python 2.4 to 2.7 again.
     62- Greatly improved unit testing, tests run with Python 2.4 to 2.7 again.
    6163
    6264Version 4.1.1 (2013-01-08)
    6365--------------------------
    64 - Add WhenNotified class and method.  Replaces need for third party pgnotify.
     66- Add NotificationHandler class and method.  Replaces need for pgnotify.
    6567- Sharpen test for inserting current_timestamp.
    6668- Add more quote tests.  False and 0 should evaluate to NULL.
  • trunk/docs/contents/pg/db_wrapper.rst

    r749 r762  
    606606
    607607.. versionadded:: 4.1
     608
     609notification_handler -- create a notification handler
     610-----------------------------------------------------
     611
     612.. class:: DB.notification_handler(event, callback, [arg_dict], [timeout], [stop_event])
     613
     614    Create a notification handler instance
     615
     616    :param str event: the name of an event to listen for
     617    :param callback: a callback function
     618    :param dict arg_dict: an optional dictionary for passing arguments
     619    :param timeout: the time-out when waiting for notifications
     620    :type timeout: int, float or None
     621    :param str stop_event: an optional different name to be used as stop event
     622
     623This method creates a :class:`pg.NotificationHandler` object using the
     624:class:`DB` connection as explained under :doc:`notification`.
     625
     626.. versionadded:: 4.1.1
  • trunk/docs/contents/pg/index.rst

    r710 r762  
    1515    query
    1616    large_objects
     17    notification
Note: See TracChangeset for help on using the changeset viewer.