From 11953e10b6fb9832196b0fdab28dd53f771c3eab Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Sun, 18 Nov 2018 23:18:01 -0600 Subject: Add "commit" to the glossary --- docs/glossary.rst | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index f42b298df..649daf79e 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1207,3 +1207,7 @@ Glossary route prefix A route prefix is a path prefix that is prepended to any routes that are configured while it is active. A route prefix can be set via :meth:`pyramid.config.Configurator.include` or :meth:`pyramid.config.Configurator.route_prefix_context`. + + commit + An operation applied to a :term:`configurator` which checks for conflicts in :term:`configuration declaration`\s, and if none are found applies all pending :term:`action`\s. + It is possible, although not necessarily recommended, to invoke :term:`commit`\s using :meth:`pyramid.config.Configurator.commit` to :ref:`manually resolve ` configuration conflicts. -- cgit v1.2.3 From 0435a459de25acb087881e8bf3b0e21aa8fca5fb Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 07:44:54 -0600 Subject: Shorter sentences are better --- docs/glossary.rst | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 649daf79e..0ff87a5ee 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1209,5 +1209,6 @@ Glossary A route prefix can be set via :meth:`pyramid.config.Configurator.include` or :meth:`pyramid.config.Configurator.route_prefix_context`. commit - An operation applied to a :term:`configurator` which checks for conflicts in :term:`configuration declaration`\s, and if none are found applies all pending :term:`action`\s. + An operation applied to a :term:`configurator`. + A commit checks for conflicts in :term:`configuration declaration`\s, and if none are found applies all pending :term:`action`\s. It is possible, although not necessarily recommended, to invoke :term:`commit`\s using :meth:`pyramid.config.Configurator.commit` to :ref:`manually resolve ` configuration conflicts. -- cgit v1.2.3 From d03e047c7e4e7cf79b84116379dddf0b82bdbfca Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 10:23:18 -0600 Subject: Add "settings" to the glossary --- docs/glossary.rst | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 0ff87a5ee..ae10ad272 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1212,3 +1212,9 @@ Glossary An operation applied to a :term:`configurator`. A commit checks for conflicts in :term:`configuration declaration`\s, and if none are found applies all pending :term:`action`\s. It is possible, although not necessarily recommended, to invoke :term:`commit`\s using :meth:`pyramid.config.Configurator.commit` to :ref:`manually resolve ` configuration conflicts. + + settings + Settings control the runtime behavior of a Pyramid application. + They are the aggregation of configuration file declarations, process environment values, other additions generated by Pyramid or its plugins and :term:`tween`\s, and values produced by your own code during application initialization. + Settings can affect all the components which make up the the application. + Pyramid itself, any tweens or Pyramid plugins used, and :ref:`your own code may reference ` and act on settings. -- cgit v1.2.3 From bf266438734bb93c9ff518b733ce7671a4eb111c Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Mon, 19 Nov 2018 11:59:05 -0600 Subject: Clarify that settings are set at startup --- docs/glossary.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index ae10ad272..15a144898 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1215,6 +1215,7 @@ Glossary settings Settings control the runtime behavior of a Pyramid application. - They are the aggregation of configuration file declarations, process environment values, other additions generated by Pyramid or its plugins and :term:`tween`\s, and values produced by your own code during application initialization. - Settings can affect all the components which make up the the application. + They are the aggregation of configuration file declarations, process environment values, other additions generated by Pyramid or its plugins and :term:`tween`\s, and values produced by your own code. + Settings are collected at application startup. + They can affect all the components which make up the the application. Pyramid itself, any tweens or Pyramid plugins used, and :ref:`your own code may reference ` and act on settings. -- cgit v1.2.3 From 0929046410929b332bdcfac2f362dd3c0f16445c Mon Sep 17 00:00:00 2001 From: "Karl O. Pinc" Date: Tue, 20 Nov 2018 06:25:14 -0600 Subject: Pyrmaid has add-ons, not plugins --- docs/glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/glossary.rst') diff --git a/docs/glossary.rst b/docs/glossary.rst index 15a144898..7f396dc7d 100644 --- a/docs/glossary.rst +++ b/docs/glossary.rst @@ -1215,7 +1215,7 @@ Glossary settings Settings control the runtime behavior of a Pyramid application. - They are the aggregation of configuration file declarations, process environment values, other additions generated by Pyramid or its plugins and :term:`tween`\s, and values produced by your own code. + They are the aggregation of configuration file declarations, process environment values, other additions generated by Pyramid or its add-ons and :term:`tween`\s, and values produced by your own code. Settings are collected at application startup. They can affect all the components which make up the the application. - Pyramid itself, any tweens or Pyramid plugins used, and :ref:`your own code may reference ` and act on settings. + Pyramid itself, any tweens or Pyramid add-ons used, and :ref:`your own code may reference ` and act on settings. -- cgit v1.2.3