github/sprockets-postgres
1
0
Fork 0
mirror of https://github.com/sprockets/sprockets-postgres.git synced 2024-09-21 10:10:57 +00:00
Code Issues Projects Releases Packages Wiki Activity

docstring update for class linking

Browse source
This commit is contained in:
Gavin M. Roy 2020-04-10 16:34:39 -04:00
parent 8aee0fec5e
commit d7406ac1d3
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/example.rst
View file

@ -23,13 +23,13 @@ The following code provides a simple example for using the
class Application(postgres.ApplicationMixin, app.Application): class Application(postgres.ApplicationMixin, app.Application):
""" """
The ``ApplicationMixin`` provides the foundation for the The :class:`sprockets_postgres.ApplicationMixin` provides the foundation
``RequestHandlerMixin`` to properly function and will automatically for the :class:`sprockets_postgres.RequestHandlerMixin` to properly function
setup the pool to connect to PostgreSQL and will shutdown the connections and will automatically setup the pool to connect to PostgreSQL and will
cleanly when the application stops. shutdown the connections cleanly when the application stops.
It should be used in conjunction with ``sprockets.http.app.Application`` It should be used in conjunction with :class:`sprockets.http.app.Application`
and not directly with ``tornado.web.Application``. and not directly with :class:``tornado.web.Application`.
""" """