summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorKarl O. Pinc <kop@meme.com>2013-10-08 06:17:13 -0500
committerKarl O. Pinc <kop@meme.com>2013-10-08 06:17:13 -0500
commiteb3b27df0a35088f631680d7f467680662f17bac (patch)
tree4e868a30a27622a3648f9f1955bd1e725a20ab44 /docs
parent6a3eed4ddc4178d19c0002ec72b9a1d6494e01ae (diff)
downloadpyramid-eb3b27df0a35088f631680d7f467680662f17bac.tar.gz
pyramid-eb3b27df0a35088f631680d7f467680662f17bac.tar.bz2
pyramid-eb3b27df0a35088f631680d7f467680662f17bac.zip
Docs: project.rst: Printf()s can be used for debugging. Output goes to the server console.
The main point of the second sentence is to setup the reader with mental context for the 3rd sentence, so that the 3rd sentence sinks in. Likewise, the parenthetical in the second sentence about server startup messages gives the reader some clue as to what the rest of the sentence it talking about. I suspect that some readers won't know what a console is, and the rest will be confused by a server run on a console.
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/project.rst12
1 files changed, 12 insertions, 0 deletions
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 8b7c24725..a454573f0 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -259,6 +259,8 @@ single sample test exists.
single: reload
single: startup
+.. _running_the_project_application:
+
Running The Project Application
-------------------------------
@@ -600,6 +602,8 @@ server which listens on TCP port 6543. It is configured to listen on all
interfaces (``0.0.0.0``). This means that any remote system which has TCP
access to your system can see your Pyramid application.
+.. _MyProject_ini_logging:
+
The sections that live between the markers ``# Begin logging configuration``
and ``# End logging configuration`` represent Python's standard library
:mod:`logging` module configuration for your application. The sections
@@ -885,6 +889,14 @@ returns the HTML in a :term:`response`.
.. note:: Dictionaries provide values to :term:`template`\s.
+.. note:: When the application is run with the scaffold's :ref:`default
+ development.ini <MyProject_ini>` configuration :ref:`logging is setup
+ <MyProject_ini_logging>` to aid debugging. Should an exception be raised,
+ uncaught tracebacks are displayed, after the startup messages, on :ref:`the
+ console running the server <running_the_project_application>`.
+ Conveniently, ``printf()``\s inserted into the application for debugging
+ also send output to this console.
+
.. note:: ``development.ini`` has a setting that controls how templates are
reloaded, ``pyramid.reload_templates``.