From f9ea3fe026a684bb47a0f4794431dab30d0f601e Mon Sep 17 00:00:00 2001 From: Armin Ronacher Date: Thu, 26 May 2016 20:52:17 +0200 Subject: [PATCH] 1.0 -> 0.11 in the docs --- docs/api.rst | 2 +- docs/cli.rst | 2 +- docs/errorhandling.rst | 2 +- docs/extensiondev.rst | 4 ++-- docs/server.rst | 2 +- docs/shell.rst | 2 +- docs/upgrading.rst | 18 ++++++++++++++---- 7 files changed, 21 insertions(+), 11 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 688b6811..e72c9ace 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -289,7 +289,7 @@ thing, like it does for :class:`request` and :class:`session`. It's now also possible to use the ``in`` operator on it to see if an attribute is defined and it yields all keys on iteration. - As of 1.0 you can use :meth:`pop` and :meth:`setdefault` in the same + As of 0.11 you can use :meth:`pop` and :meth:`setdefault` in the same way you would use them on a dictionary. This is a proxy. See :ref:`notes-on-proxies` for more information. diff --git a/docs/cli.rst b/docs/cli.rst index 72184b0a..5af0cf88 100644 --- a/docs/cli.rst +++ b/docs/cli.rst @@ -7,7 +7,7 @@ Command Line Interface .. currentmodule:: flask -One of the nice new features in Flask 1.0 is the built-in integration of +One of the nice new features in Flask 0.11 is the built-in integration of the `click `_ command line interface. This enables a wide range of new features for the Flask ecosystem and your own applications. diff --git a/docs/errorhandling.rst b/docs/errorhandling.rst index af593531..4210cae3 100644 --- a/docs/errorhandling.rst +++ b/docs/errorhandling.rst @@ -131,7 +131,7 @@ Logging to a File Even if you get mails, you probably also want to log warnings. It's a good idea to keep as much information around that might be required to -debug a problem. By default as of Flask 1.0, errors are logged to your +debug a problem. By default as of Flask 0.11, errors are logged to your webserver's log automatically. Warnings however are not. Please note that Flask itself will not issue any warnings in the core system, so it's your responsibility to warn in the code if something seems odd. diff --git a/docs/extensiondev.rst b/docs/extensiondev.rst index 9119abdb..d73d6019 100644 --- a/docs/extensiondev.rst +++ b/docs/extensiondev.rst @@ -408,8 +408,8 @@ Flask 0.8 introduced a redirect import system as a compatibility aid for app developers: Importing ``flask.ext.foo`` would try ``flask_foo`` and ``flaskext.foo`` in that order. -As of Flask 1.0, most Flask extensions have transitioned to the new naming -schema. The ``flask.ext.foo`` compatibility alias is still in Flask 1.0 but is +As of Flask 0.11, most Flask extensions have transitioned to the new naming +schema. The ``flask.ext.foo`` compatibility alias is still in Flask 0.11 but is now deprecated -- you should use ``flask_foo``. diff --git a/docs/server.rst b/docs/server.rst index 98bbfdad..f8332ebf 100644 --- a/docs/server.rst +++ b/docs/server.rst @@ -5,7 +5,7 @@ Development Server .. currentmodule:: flask -Starting with Flask 1.0 there are multiple built-in ways to run a +Starting with Flask 0.11 there are multiple built-in ways to run a development server. The best one is the :command:`flask` command line utility but you can also continue using the :meth:`Flask.run` method. diff --git a/docs/shell.rst b/docs/shell.rst index 0caf9139..9d9bb5f9 100644 --- a/docs/shell.rst +++ b/docs/shell.rst @@ -29,7 +29,7 @@ chapter of the documentation first. Command Line Interface ---------------------- -Starting with Flask 1.0 the recommended way to work with the shell is the +Starting with Flask 0.11 the recommended way to work with the shell is the ``flask shell`` command which does a lot of this automatically for you. For instance the shell is automatically initialized with a loaded application context. diff --git a/docs/upgrading.rst b/docs/upgrading.rst index eede3f6e..5ab73868 100644 --- a/docs/upgrading.rst +++ b/docs/upgrading.rst @@ -21,13 +21,23 @@ installation, make sure to pass it the :option:`-U` parameter:: .. _upgrading-to-10: -Version 1.0 ------------ +Version 0.11 +------------ + +0.11 is an odd release in the Flask release cycle because it was supposed +to be the 1.0 release. However because there was such a long lead time up +to the release we decided to push out a 0.11 release first with some +changes removed to make the transition easier. If you have been tracking +the master branch which was 1.0 you might see some unexpected changes. + +In case you did track the master branch you will notice that `flask --app` +is removed now. You need to use the environment variable to specify an +application. Debugging ````````` -Flask 1.0 removed the ``debug_log_format`` attribute from Flask +Flask 0.11 removed the ``debug_log_format`` attribute from Flask applications. Instead the new ``LOGGER_HANDLER_POLICY`` configuration can be used to disable the default log handlers and custom log handlers can be set up. @@ -206,7 +216,7 @@ before, you should catch them with :exc:`RuntimeError` now. Additionally the :func:`~flask.send_file` function is now issuing deprecation warnings if you depend on functionality that will be removed -in Flask 1.0. Previously it was possible to use etags and mimetypes +in Flask 0.11. Previously it was possible to use etags and mimetypes when file objects were passed. This was unreliable and caused issues for a few setups. If you get a deprecation warning, make sure to update your application to work with either filenames there or disable