From d7406ac1d34ac7aef14606c047dd121162b2e40f Mon Sep 17 00:00:00 2001 From: "Gavin M. Roy" Date: Fri, 10 Apr 2020 16:34:39 -0400 Subject: [PATCH] docstring update for class linking --- docs/example.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/example.rst b/docs/example.rst index d3c95bd..3942cb5 100644 --- a/docs/example.rst +++ b/docs/example.rst @@ -23,13 +23,13 @@ The following code provides a simple example for using the class Application(postgres.ApplicationMixin, app.Application): """ - The ``ApplicationMixin`` provides the foundation for the - ``RequestHandlerMixin`` to properly function and will automatically - setup the pool to connect to PostgreSQL and will shutdown the connections - cleanly when the application stops. + The :class:`sprockets_postgres.ApplicationMixin` provides the foundation + for the :class:`sprockets_postgres.RequestHandlerMixin` to properly function + and will automatically setup the pool to connect to PostgreSQL and will + shutdown the connections cleanly when the application stops. - It should be used in conjunction with ``sprockets.http.app.Application`` - and not directly with ``tornado.web.Application``. + It should be used in conjunction with :class:`sprockets.http.app.Application` + and not directly with :class:``tornado.web.Application`. """