summaryrefslogtreecommitdiff
path: root/docs/narr
AgeCommit message (Collapse)Author
2012-03-19windowsChris McDonough
2012-03-19wordingChris McDonough
2012-03-19use the correct messageChris McDonough
2012-03-19show the effect of a server restart under reload; explain that template ↵Chris McDonough
changes dont require a restart
2012-03-19provide instructions about how to change the port, warn against changing the ↵Chris McDonough
server, put code reloading into its own section
2012-03-19explain where things might go in reality and explain gt example Windows ↵Chris McDonough
convention
2012-03-18warn about project names that shadow stdlib names, change UNIX prompt to gtChris McDonough
2012-03-18Fixed line width.Michael Merickel
2012-03-18Merge branch 'patch-4' of https://github.com/rach/pyramid into pull.500Michael Merickel
2012-03-18Merge pull request #499 from rach/patch-3Michael Merickel
Keep the same vocabulary than previously in the doc
2012-03-18Suggestion : giving at least the name the command to use as an indication . Rachid Belaid
Even if this information it's not enough, when you read the doc via pdf that give you which command to use without having to jump of section. I find it better for the learning flow of the reader than jumping around.
2012-03-18Keep the same vocabulary than previously in the doc, at this stage of the ↵Rachid Belaid
instruction the user doesn't have more than one package which myproject
2012-03-18Keep the same notation, 'myproject' is used previously. 'mypackage' is ↵Rachid Belaid
correct and generic, after following the previous step of the documentation the user would have only one package which is 'myproject'
2012-03-17misspelling : change 'pryamid_debugtoolbar' into 'pyramid_debugtoolbar'Rachid Belaid
2012-03-17- Remove references to do-nothing ``pyramid.debug_templates`` setting in allChris McDonough
Pyramid-provided ``.ini`` files. This setting previously told Chameleon to render better exceptions; now Chameleon always renders nice exceptions regardless of the value of this setting. Fixes #491.
2012-03-15remove debug_templates untruths related to issue #491Chris McDonough
2012-03-13TyposPatricio Paez
2012-03-11only selfChris McDonough
2012-03-11view class methods were missing self parameter.Carlos de la Guardia
2012-03-05add_traverserChris McDonough
2012-03-02Merge branch '1.3-branch'Chris McDonough
2012-03-02Correct section name in pshell example.Martijn Pieters
The section in the example is called 'app:main', not 'app:MyProject'.
2012-03-02Correct minor grammatical error.Martijn Pieters
2012-03-02Remove some confusion about finished callbacks.Ruslan Spivak
Rework an example code and remove an incorrect statement about request.exception being set when an exception occurs in a view. The reason for the change is issue #454: https://github.com/Pylons/pyramid/issues/454
2012-03-01Merge branch 'master' into 1.3-branchChris McDonough
2012-03-01wrong class name, fixes #451Chris McDonough
2012-03-01Remove mention of the `root_factory` argument.Martijn Pieters
The example code earlier on the page does not use the `root_factory` argument, only the `settings` argument. This is a fix for pyramid issue #452.
2012-02-29fix decoratorsChris McDonough
2012-02-26fix instance creationChris McDonough
2012-02-26make latex render againChris McDonough
2012-02-24docs-deprecate tmpl_contextChris McDonough
2012-02-24Merge branch 'master' into 1.3-branchChris McDonough
2012-02-24More trivial typosPaul Winkler
2012-02-24Trivial typosPaul Winkler
2012-02-23fixChris McDonough
2012-02-22fixChris McDonough
2012-02-22allow user to pass content type and encoding, change favicon example to use ↵Chris McDonough
FileResponse
2012-02-22Merge branch 'master' of github.com:Pylons/pyramidChris McDonough
2012-02-22- New API: ``pyramid.config.Configurator.add_forbidden_view``. This is aChris McDonough
wrapper for ``pyramid.Config.configurator.add_view`` which does the right thing about permissions. It should be preferred over calling ``add_view`` directly with ``context=HTTPForbidden`` as was previously recommended. - New API: ``pyramid.view.forbidden_view_config``. This is a decorator constructor like ``pyramid.view.view_config`` that calls ``pyramid.config.Configurator.add_forbidden_view`` when scanned. It should be preferred over using ``pyramid.view.view_config`` with ``context=HTTPForbidden`` as was previously recommended. - Updated the "Creating a Not Forbidden View" section of the "Hooks" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_forbidden_view`` or ``forbidden_view_config``. - Updated all tutorials to use ``pyramid.view.forbidden_view_config`` rather than ``pyramid.view.view_config`` with an HTTPForbidden context.
2012-02-22- New API: ``pyramid.config.Configurator.add_notfound_view``. This is aChris McDonough
wrapper for ``pyramid.Config.configurator.add_view`` which provides easy append_slash support. It should be preferred over calling ``add_view`` directly with ``context=HTTPNotFound`` as was previously recommended. - New API: ``pyramid.view.notfound_view_config``. This is a decorator constructor like ``pyramid.view.view_config`` that calls ``pyramid.config.Configurator.add_notfound_view`` when scanned. It should be preferred over using ``pyramid.view.view_config`` with ``context=HTTPNotFound`` as was previously recommended. - The older deprecated ``set_notfound_view`` Configurator method is now an alias for the new ``add_notfound_view`` Configurator method. This has the following impact: the ``context`` sent to views with a ``(context, request)`` call signature registered via the deprecated ``add_notfound_view``/``set_notfound_view`` will now be the HTTPNotFound exception object instead of the actual resource context found. Use ``request.context`` to get the actual resource context. It's also recommended to disuse ``set_notfound_view`` in favor of ``add_notfound_view``, despite the aliasing. - The API documentation for ``pyramid.view.append_slash_notfound_view`` and ``pyramid.view.AppendSlashNotFoundViewFactory`` was removed. These names still exist and are still importable, but they are no longer APIs. Use ``pyramid.config.Configurator.add_notfound_view(append_slash=True)`` or ``pyramid.view.notfound_view_config(append_slash=True)`` to get the same behavior. - The ``set_forbidden_view`` method of the Configurator was removed from the documentation. It has been deprecated since Pyramid 1.1. - The AppendSlashNotFoundViewFactory used request.path to match routes. This was wrong because request.path contains the script name, and this would cause it to fail in circumstances where the script name was not empty. It should have used request.path_info, and now does. - Updated the "Registering a Not Found View" section of the "Hooks" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_notfound_view`` or ``notfound_view_config``. - Updated the "Redirecting to Slash-Appended Routes" section of the "URL Dispatch" chapter, replacing explanations of registering a view using ``add_view`` or ``view_config`` with ones using ``add_notfound_view`` or ``notfound_view_config``
2012-02-21Fix favicon_view example: open the file in binary mode.Marius Gedminas
Without this fix Python 3 users might get Unicode errors, and Windows users might get data corruption.
2012-02-20FeaturesChris McDonough
-------- - Add an ``introspection`` boolean to the Configurator constructor. If this is ``True``, actions registered using the Configurator will be registered with the introspector. If it is ``False``, they won't. The default is ``True``. Setting it to ``False`` during action processing will prevent introspection for any following registration statements, and setting it to ``True`` will start them up again. This addition is to service a requirement that the debug toolbar's own views and methods not show up in the introspector. Backwards Incompatibilities --------------------------- - Remove ``pyramid.config.Configurator.with_context`` class method. It was never an API, it is only used by ``pyramid_zcml`` and its functionality has been moved to that package's latest release. This means that you'll need to use the latest release of ``pyramid_zcml`` with this release of Pyramid. - The ``introspector`` argument to the ``pyramid.config.Configurator`` constructor API has been removed. It has been replaced by the boolean ``introspection`` flag. - The ``pyramid.registry.noop_introspector`` API object has been removed.
2012-02-19- Put ``pyramid.includes`` targets within ini files in scaffolds on separateChris McDonough
lines in order to be able to tell people to comment out only the ``pyramid_debugtoolbar`` line when they want to disable the toolbar.
2012-02-18dont mention arg by nameChris McDonough
2012-02-18move add_traverser and add_resource_url_adapter to adaptersChris McDonough
2012-02-18expandChris McDonough
2012-02-18minor wording fixesChris McDonough
2012-02-17docs fixesChris McDonough
2012-02-17FeaturesChris McDonough
-------- - Add ``pyramid.config.Configurator.add_resource_url_adapter`` API method. See the Hooks narrative documentation section entitled "Changing How pyramid.request.Request.resource_url Generates a URL" for more information. This is not a new feature, it just provides an API for adding a resource url adapter without needing to use the ZCA API. - A new interface was added: ``pyramid.interfaces.IResourceURL``. An adapter implementing its interface can be used to override resource URL generation when ``request.resource_url`` is called. This interface replaces the now-deprecated ``pyramid.interfaces.IContextURL`` interface. - The dictionary passed to a resource's ``__resource_url__`` method (see "Overriding Resource URL Generation" in the "Resources" chapter) now contains an ``app_url`` key, representing the application URL generated during ``request.resource_url``. It represents a potentially customized URL prefix, containing potentially custom scheme, host and port information passed by the user to ``request.resource_url``. It should be used instead of ``request.application_url`` where necessary. - The ``request.resource_url`` API now accepts these arguments: ``app_url``, ``scheme``, ``host``, and ``port``. The app_url argument can be used to replace the URL prefix wholesale during url generation. The ``scheme``, ``host``, and ``port`` arguments can be used to replace the respective default values of ``request.application_url`` partially. - A new API named ``request.resource_path`` now exists. It works like ``request.resource_url`` but produces a relative URL rather than an absolute one. - The ``request.route_url`` API now accepts these arguments: ``_app_url``, ``_scheme``, ``_host``, and ``_port``. The ``_app_url`` argument can be used to replace the URL prefix wholesale during url generation. The ``_scheme``, ``_host``, and ``_port`` arguments can be used to replace the respective default values of ``request.application_url`` partially. Backwards Incompatibilities --------------------------- - The ``pyramid.interfaces.IContextURL`` interface has been deprecated. People have been instructed to use this to register a resource url adapter in the "Hooks" chapter to use to influence ``request.resource_url`` URL generation for resources found via custom traversers since Pyramid 1.0. The interface still exists and registering such an adapter still works, but this interface will be removed from the software after a few major Pyramid releases. You should replace it with an equivalent ``pyramid.interfaces.IResourceURL`` adapter, registered using the new ``pyramid.config.Configurator.add_resource_url_adapter`` API. A deprecation warning is now emitted when a ``pyramid.interfaces.IContextURL`` adapter is found when ``request.resource_url`` is called. Misc ---- - Change ``set_traverser`` API name to ``add_traverser``. Ref #438.
2012-02-15Use req instead of r for #413. It's more likely that somebody is already ↵Chris McDonough
passing something named r, and a template may depend on its existence or nonexistence to conditionalize rendering a bit of html.