From 20d0a0ed4358c5c00907d44f1d1a767121d8655d Mon Sep 17 00:00:00 2001 From: "Gavin M. Roy" Date: Fri, 11 Mar 2016 10:29:14 -0500 Subject: [PATCH] Update documentation --- docs/api.rst | 5 +++++ docs/history.rst | 9 ++++++++- 2 files changed, 13 insertions(+), 1 deletion(-) diff --git a/docs/api.rst b/docs/api.rst index f6ef8eb..26a0d8f 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -22,6 +22,11 @@ call when specific events occur. The following events are supported: If any callback raises an exception, then the application is terminated **before** the IOLoop is started. +:on_start: + This set of callbacks is invoked after Tornado forks sub-processes + (based on the ``number_of_procs`` setting) and **after** + :meth:`~tornado.ioloop.IOLoop.start` is called. + :shutdown: When the application receives a stop signal, it will run each of the callbacks before terminating the application instance. Exceptions diff --git a/docs/history.rst b/docs/history.rst index add506d..9def2db 100644 --- a/docs/history.rst +++ b/docs/history.rst @@ -2,6 +2,12 @@ Release History =============== +`1.2.0`_ (11 Mar 2016) +---------------------- +- Add support for the ``on_start`` callback. +- Add support to wait for the completion of ``shutdown`` callbacks that + return a future. +- Adds new init params to runner.Runner for the three callback types `1.1.2`_ (23 Feb 2016) ---------------------- @@ -61,4 +67,5 @@ Release History .. _1.0.1: https://github.com/sprockets/sprockets.http/compare/1.0.0...1.0.1 .. _1.0.2: https://github.com/sprockets/sprockets.http/compare/1.0.1...1.0.2 .. _1.1.0: https://github.com/sprockets/sprockets.http/compare/1.0.2...1.1.0 -.. _Next Release: https://github.com/sprockets/sprockets.http/compare/1.1.0...master +.. _1.2.0: https://github.com/sprockets/sprockets.http/compare/1.0.2...1.2.0 +.. _Next Release: https://github.com/sprockets/sprockets.http/compare/1.2.0...master