From 8f4fcc47c9405f20cfed3a40931f12534b3b7193 Mon Sep 17 00:00:00 2001 From: Chris McDonough Date: Tue, 20 Nov 2012 22:47:50 -0500 Subject: coverage --- docs/api/paster.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/api') diff --git a/docs/api/paster.rst b/docs/api/paster.rst index 3f7a1c364..bde128e05 100644 --- a/docs/api/paster.rst +++ b/docs/api/paster.rst @@ -7,7 +7,7 @@ .. autofunction:: bootstrap - .. autofunction:: get_app(config_uri, name=None) + .. autofunction:: get_app(config_uri, name=None, options=None) .. autofunction:: get_appsettings(config_uri, name=None) -- cgit v1.2.3 From e0062294430dd1d30d31b9f8c0a2e6e9060bcb76 Mon Sep 17 00:00:00 2001 From: Paul Everitt Date: Tue, 1 Jan 2013 11:49:52 -0500 Subject: Small fix for RST misfire. --- docs/api/registry.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'docs/api') diff --git a/docs/api/registry.rst b/docs/api/registry.rst index 1d5d52248..4c1af2678 100644 --- a/docs/api/registry.rst +++ b/docs/api/registry.rst @@ -14,12 +14,12 @@ accessed as ``request.registry.settings`` or ``config.registry.settings`` in a typical Pyramid application. - .. attribute:: introspector + .. attribute:: introspector When a registry is set up (or created) by a :term:`Configurator`, the registry will be decorated with an instance named ``introspector`` implementing the :class:`pyramid.interfaces.IIntrospector` interface. - See also :attr:`pyramid.config.Configurator.introspector``. + See also :attr:`pyramid.config.Configurator.introspector`. When a registry is created "by hand", however, this attribute will not exist until set up by a configurator. -- cgit v1.2.3 From 08c2217e7f831379016e1ddee0b5d51eeca53878 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 1 Jan 2013 23:56:02 +0200 Subject: eliminate repeated "the" words --- docs/api/request.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/api') diff --git a/docs/api/request.rst b/docs/api/request.rst index 3a1439874..e4034c635 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -251,7 +251,7 @@ Assigning to one is still supported but will cause a deprecation warning to be emitted, and eventually the feature will be removed. For new code, instead of assigning ``response_*`` attributes to the - request, use API of the the :attr:`pyramid.request.Request.response` + request, use API of the :attr:`pyramid.request.Request.response` object (exposed to view code as ``request.response``) to influence rendered response behavior. -- cgit v1.2.3 From 043ccddb909327106264d10ed5d413760a51770d Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 2 Jan 2013 02:22:52 +0200 Subject: eliminate other repeated words --- docs/api/registry.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/api') diff --git a/docs/api/registry.rst b/docs/api/registry.rst index 4c1af2678..a7879d3d5 100644 --- a/docs/api/registry.rst +++ b/docs/api/registry.rst @@ -33,7 +33,7 @@ The default implementation of the interface :class:`pyramid.interfaces.IIntrospectable` used by framework exenders. - An instance of this class is is created when + An instance of this class is created when :attr:`pyramid.config.Configurator.introspectable` is called. This class is new as of :app:`Pyramid` 1.3. -- cgit v1.2.3 From de5d2a88ef64a3f59222be1bd369ce226bbc0171 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Mon, 7 Jan 2013 01:37:30 +0200 Subject: redundant statement: the links preceeding the statement target the info referred to --- docs/api/path.rst | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) (limited to 'docs/api') diff --git a/docs/api/path.rst b/docs/api/path.rst index d46c35d8e..814fc47d5 100644 --- a/docs/api/path.rst +++ b/docs/api/path.rst @@ -9,8 +9,7 @@ A constant used by the constructor of :class:`pyramid.path.DottedNameResolver` and - :class:`pyramid.path.AssetResolver` (see their docstrings for more - info). + :class:`pyramid.path.AssetResolver`. .. autoclass:: DottedNameResolver :members: -- cgit v1.2.3 From fa1ac6744f1e2308190ba84dd60d573b4fa25fb3 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 15 Jan 2013 00:56:42 +0200 Subject: another grammar fix --- docs/api/config.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/api') diff --git a/docs/api/config.rst b/docs/api/config.rst index 5d2bce23e..e6a67830e 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -130,7 +130,7 @@ .. attribute:: global_registries The set of registries that have been created for :app:`Pyramid` - applications, one per each call to + applications, one for each call to :meth:`pyramid.config.Configurator.make_wsgi_app` in the current process. The object itself supports iteration and has a ``last`` property containing the last registry loaded. -- cgit v1.2.3 From 0b23b34cf7f759d7f2895696b8ec07c3a4d1e80a Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 23 Jan 2013 01:43:48 +0200 Subject: pyramid.config: take advantage of some Sphinx directives * versionadded * versionchanged * deprecated --- docs/api/config.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) (limited to 'docs/api') diff --git a/docs/api/config.rst b/docs/api/config.rst index e6a67830e..39d504348 100644 --- a/docs/api/config.rst +++ b/docs/api/config.rst @@ -108,9 +108,7 @@ :class:`pyramid.registry.Introspectable` class (used during directives to provide introspection to actions). - .. note:: - - This attribute is new as of :app:`Pyramid` 1.3. + .. versionadded:: 1.3 .. attribute:: introspector @@ -118,9 +116,7 @@ instance implementing the :class:`pyramid.interfaces.IIntrospector` interface. - .. note:: - - This attribute is new as of :app:`Pyramid` 1.3. + .. versionadded:: 1.3 .. attribute:: registry -- cgit v1.2.3 From 23c8985a661b9e2b11b76750893724dc747ffc1c Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Tue, 29 Jan 2013 01:23:02 +0200 Subject: replace 'note' with the more correct 'versionadded' directive --- docs/api/request.rst | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'docs/api') diff --git a/docs/api/request.rst b/docs/api/request.rst index e4034c635..9f1f71b31 100644 --- a/docs/api/request.rst +++ b/docs/api/request.rst @@ -163,9 +163,7 @@ .. method:: invoke_subrequest(request, use_tweens=False) - .. warning:: - - This API was added in Pyramid 1.4a1. + .. versionadded:: 1.4a1 Obtain a response object from the Pyramid application based on information in the ``request`` object provided. The ``request`` object -- cgit v1.2.3 From 40dbf42a2df1783c3d803adf950380c21512bb91 Mon Sep 17 00:00:00 2001 From: Tshepang Lekhonkhobe Date: Wed, 30 Jan 2013 00:41:23 +0200 Subject: use the more appropriate directives --- docs/api/registry.rst | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) (limited to 'docs/api') diff --git a/docs/api/registry.rst b/docs/api/registry.rst index a7879d3d5..db348495c 100644 --- a/docs/api/registry.rst +++ b/docs/api/registry.rst @@ -16,6 +16,8 @@ .. attribute:: introspector + .. versionadded:: 1.3 + When a registry is set up (or created) by a :term:`Configurator`, the registry will be decorated with an instance named ``introspector`` implementing the :class:`pyramid.interfaces.IIntrospector` interface. @@ -27,28 +29,23 @@ This attribute is often accessed as ``request.registry.introspector`` in a typical Pyramid application. - This attribute is new as of :app:`Pyramid` 1.3. - .. class:: Introspectable + .. versionadded:: 1.3 + The default implementation of the interface :class:`pyramid.interfaces.IIntrospectable` used by framework exenders. An instance of this class is created when :attr:`pyramid.config.Configurator.introspectable` is called. - This class is new as of :app:`Pyramid` 1.3. - .. autoclass:: Deferred - This class is new as of :app:`Pyramid` 1.4. + .. versionadded:: 1.4 .. autofunction:: undefer - This function is new as of :app:`Pyramid` 1.4. + .. versionadded:: 1.4 .. autoclass:: predvalseq - This class is new as of :app:`Pyramid` 1.4. - - - + .. versionadded:: 1.4 -- cgit v1.2.3