Commit Graph

193 Commits

Author SHA1 Message Date
Daiana Marasquin 104808b480
fix syntax error and typo in quickstart.rst 2018-04-29 14:51:13 -07:00
David Lord 303a3d24a6
rewrite quickstart Unique URLs section 2018-02-24 08:03:30 -08:00
David Lord 87c2e121e0
clean up FLASK_ENV docs [ci skip] 2018-01-10 15:46:11 -08:00
Armin Ronacher 2433522d29
Add Support for FLASK_ENV (#2570)
This introduces environments to Flask
2018-01-06 17:07:56 +01:00
Vladimir Kroz d08d96acbc Fix code example for HTTP Methods
`return` is required to make 'http methods' example work
2017-12-05 17:59:04 +01:00
David Lord 465922e5f1
clean up secret key docs
consistent key across docs and examples
consistent key across tests, set in conftest
2017-06-28 07:58:06 -07:00
Levi Roth 954d9ca0b8 Added documentation for PowerShell environment variables 2017-05-23 14:30:39 -04:00
Tully Rankin 50b73f967b Removed the version number out of the documenation link to Werkzeug. 2017-05-22 12:19:52 -07:00
Tully Rankin 409dd15c10 Added link to using Werkzeug debugger in quickstart documentation. 2017-05-22 12:14:52 -07:00
David Lord 2592f927a0
wrap lines
tighten up wording
remove any converter from quickstart
use correct rst code syntax
2017-05-11 22:31:19 -07:00
Xephyr826 dfb03c5673 Improve Routing section
Edited the entire section for clarity and concision. I rewrote sentences
to make them shorter and to reduce ambiguity.

Added a code sample to show the path converter type

Removed the HTTP method overview. Although it was well written, the
overview wasn't necessary in the quickstart. Readers can easily find an
overview elsewhere.
2017-05-10 22:38:22 -07:00
Jan Ferko 1add1f8a02 Use print function in quickstart (#2204)
Example in URL Building section uses `print` statement
instead of `print` function, which causes syntax error
when example is run on Python 3.
2017-03-13 13:58:24 +01:00
Jeff Widman bb0e755c80 Migrate various docs links to https (#2180)
Also fixed a few outdated links
2017-02-11 10:43:11 +01:00
Swan Htet Aung f84fdadda9 Update 4.4.3 HTTP Methods Example
Otherwise it produces `ValueError: View function did not return a response`.
2017-02-09 18:01:12 +06:30
Dennis Chen 9900a72fe7 Fix Request Reference (#2151)
Points flask.Request to appropriate place in the documentation.
2017-01-14 21:58:45 +01:00
Michael Recachinas 49ecc88d99 Remove `-a/--app` from Quickstart documentation (#2046)
* Remove `-a/--app` from Quickstart documentation

As mentioned in #2009, simplifying the CLI saw the removal of the `-a/--app` flag. Therefore, the only way to specify the module to import is by setting `FLASK_APP`.

* Remove misleading `either` from CLI help

The CLI help details how to run the application, but still uses the phrasing "either through the `FLASK_APP`...". This likely is an artifact from when `-a/--app` was still present in the CLI.
2016-10-01 18:45:22 +02:00
dawran6 3d856e03fc sessions documentation (client side vs server side) #434 (#1888)
Mention the existence of Flask extentions that handle server-side
sessions.
Attempt to improve the reading flow.
2016-08-29 00:06:53 +02:00
David Lord 1928f28a68 clean up code formatting in some docs
fix warnings while building docs
2016-06-26 13:03:29 -07:00
David Lord cd1a9b7d54 remove unnecessary form action attributes 2016-06-22 15:01:41 -07:00
Markus Unterwaditzer f91aea2aa0 quickstart: Remove reference to `python hello.py`
Fix #1826
2016-05-29 15:46:48 +02:00
Armin Ronacher a7d829c618 Update docs to the new CLI patterns 2016-05-26 20:45:50 +02:00
bagratte 9a80fe691d minor revision of documentation. 2016-04-01 23:12:25 +02:00
lord63 e0a8fd3162 Add two missing converters for flask in the docs
All converters are from werkzeug's builtin converters.

Documentation: http://werkzeug.pocoo.org/docs/dev/routing/#builtin-converters
2016-04-01 14:05:11 -07:00
Markus Unterwaditzer 66b4ea91b4 Fix #1195 2015-06-06 06:25:41 +02:00
Justin Poehnelt 17d7353d39 fixed import of werkzeug secure_filename 2015-05-14 23:44:49 -07:00
Phil Schaf 9d3c4bbb8c Added docs for the error handler rework 2015-04-11 17:25:17 +02:00
Winston Kouch 5f8c850895 Add extensions section to Quickstart documentation 2015-03-11 23:54:09 -04:00
Carlos Eduardo Rivera 65465ffece grammar fixes 2015-01-16 03:36:17 -06:00
Sateesh b9eb805167 Update quickstart.rst
Minor grammar correction.
2014-12-30 22:40:13 +05:30
Markus Unterwaditzer f166894f76 Merge branch 'flask_deployment_docs'
Conflicts:
	docs/quickstart.rst
2014-12-04 22:39:28 +01:00
defuz 1501b79293 docs: :exc:`TypeError` 2014-11-05 08:16:27 +03:00
defuz d4b9b9854c docs: :mimetype:`application/json` 2014-11-05 07:43:00 +03:00
defuz 663802e976 docs: ``with``, ``for``, ``self`` 2014-11-05 07:39:54 +03:00
defuz 06d9a5e738 docs: :file:`/var/www/foo`, ``/static`` 2014-11-05 07:19:02 +03:00
defuz 02694d609f docs: :command:`pip`, :option:`--debug` 2014-11-05 07:03:55 +03:00
defuz a8f570cc62 docs: :file:`app.py`, :file:`yourapp/templates` 2014-11-05 06:45:22 +03:00
defuz 3fa4fd0908 docs: http method names like ``GET`` and ``POST`` 2014-11-05 06:13:01 +03:00
Petr Zemek d1423b3e16 Unify the uses of "file system" vs "fileystem".
Use "filesystem", which is more prevailing in the source code.
2014-10-27 11:33:45 +01:00
Markus Unterwaditzer 5c6d789e7b Fix broken link 2014-10-26 02:01:42 +02:00
Kevin Funk 0632d53f3d Update quickstart.rst
url converters: match the [API docs](http://flask.pocoo.org/docs/0.10/api/#url-route-registrations)
2014-09-19 15:22:37 -07:00
Markus Unterwaditzer 3d3b809347 Rewrite deployment docs 2014-09-06 22:20:02 +02:00
Nico Revin 22219f51e5 Update doclinks
Fix redirects and broken links
2014-07-24 23:30:50 +04:00
Armin Ronacher 67e4d3ee63 Merge branch 'master' of github.com:mitsuhiko/flask 2014-04-28 13:29:31 +02:00
Armin Ronacher e9d1fc47bf Updated docs for click support 2014-04-28 13:27:13 +02:00
Daniel Neuhäuser 51228ad0d1 Use https for devcenter.heroku.com 2014-04-26 01:37:19 +02:00
Daniel Neuhäuser 52def324b8 Use https instead of http for docs.python.org 2014-04-26 01:36:36 +02:00
Daniel Neuhäuser 20edb3189c Fix Pocoo documentation links 2014-04-26 01:20:12 +02:00
Daniel Neuhäuser caa0c00420 Merge pull request #878 from shamrin/patch-1
quickstart: import `request` in HTTP methods example
2014-03-13 20:33:46 +01:00
Armin Ronacher ba36d57729 Merge pull request #897 from d3spis3d/master
URL Reversing in Quickstart Doc #779
2014-02-09 13:20:46 +00:00
Mikael Åhlén 70f8b39c52 added a new behaviour for responses that enable the tuple to be in the form of (response, headers) and continiue to support the (response, status, headers) format. 2013-12-31 22:16:13 +01:00
d3spis3d 05dbf52fa5 URL Reversing in Quickstart #779
Updated quickstart to make clear that URL reversing refers to the use of
url_for() to build the URL. Issue #779
2013-10-30 11:29:18 +11:00
Alexey Shamrin f161a71c19 quickstart: import `request` in HTTP methods example 2013-10-03 05:15:27 +04:00
Daniel Neuhäuser 5207c69064 Fix #856 ommited typo in quickstart 2013-09-03 19:47:00 +02:00
Daniel Neuhäuser c8961c6dc9 Merge pull request #786 from mgaitan/patch-1
Missing `s` in a plural word
2013-07-01 06:44:03 -07:00
Martín Gaitán 4028e2395c plural 2013-06-30 13:17:39 -03:00
BobStevens 9fe209b497 fixed typo 2013-06-27 16:32:20 -04:00
BobStevens e2fdf28e97 word change for clarity
changed "200 error code" to "200 status code"
2013-06-27 16:31:04 -04:00
= 1723990aee Fixed a few typos on quickstart 2013-03-26 21:23:55 +00:00
Michael N. Gagnon 8a6cba9e63 fix typo in quickstart guide 2013-03-15 07:31:00 -07:00
Kenneth Reitz b9118ca0cc Merge pull request #681 from dmizelle/docs-quickstart
fixes #677 - mistype in docs/quickstart
2013-03-06 09:53:36 -08:00
Alex Couper 1be13297c1 Remove comma. 2013-02-22 15:34:16 +00:00
Alex Couper 8ee01ad5ed Put the link to Flask class docs at the end. 2013-02-22 15:33:20 +00:00
Alex Couper cc8a85d753 Move docs explaining instantiating Flask 2013-02-22 11:21:17 +00:00
Devon Mizelle c999c179a2 fixes #677 - mistype in docs/quickstart 2013-02-17 11:04:20 -05:00
jfinkels 639817b621 Update docs/quickstart.rst
Removed incorrect syntax and simplified remaining sentence.
2012-10-05 02:49:55 -03:00
Kenneth Reitz 0f3bc38a18 Merge pull request #562 from yaph/master
Small improvement to docs
2012-07-21 04:57:39 -07:00
Ramiro Gomez 3800c7396b Try to correct confusing sentence in doc and fixed word duplication. 2012-07-21 13:55:45 +02:00
bev-a-tron 1f82d02b33 Fixes #519 by adding return statement 2012-06-25 13:31:11 -04:00
Alex Vykalyuk 028229d0ff Fixed typo in docs/quickstart 2012-04-23 00:32:48 +03:00
Alex Vykalyuk 0333c824bf Removed link to ep.io from quickstart 2012-04-21 22:27:24 +03:00
Ron DuPlain a3cb2a3382 Use American English for "behavior" in docs.
Prompted by plaes on #pocoo, mitsuhiko confirmed to use American English.
2012-04-19 11:51:38 -04:00
Paul McMillan acb61ae57b Minor docs fix. 2012-04-10 13:14:38 -07:00
Armin Ronacher cf1641e5be Changed the implementation of returning tuples from functions 2012-04-09 15:56:33 +01:00
Ron DuPlain b16c988f1e Fix static endpoint name mention in quickstart. 2012-04-03 20:55:58 -04:00
Sergey e76db15e26 Update docs/quickstart.rst 2012-03-31 10:11:12 +03:00
Ron DuPlain 3bf1750b5d Tighten quickstart deployment docs. 2012-03-13 12:12:47 -07:00
Ron DuPlain 1d1db80e06 Merge pull request #427 from kevinburke/fix-existing-tutorial
add heroku/deploy options to quickstart, and add clearer links in tutorial setup
2012-03-13 11:47:04 -07:00
Kevin Burke 2befab24c5 remove localtunnel things that were added to snippets 2012-03-11 23:17:40 -07:00
Kevin Burke 605d0ee344 update links 2012-03-11 20:33:43 -07:00
Kevin Burke 6b9e6a5a52 add heroku/deploy options to quickstart, and add more clear links in tutorial setup. 2012-03-11 20:20:32 -07:00
Paul McMillan b9f4e0bd9c Remove redundant words from quickstart. 2012-02-26 12:49:52 -08:00
Ron DuPlain 69e7a0a2a0 Move debugger details into a new section, #343. 2012-02-03 18:11:14 -05:00
Ron DuPlain dfd3ef6d54 Add cookie size limit note to sessions section.
Result of discussion with jujule_ on #pocoo irc.
2012-02-03 13:19:04 -05:00
Ron DuPlain ed40eacf42 Add tiny doc touchups. 2012-01-16 21:45:19 -05:00
Ori Livneh df19ee95bd more editorial work 2012-01-16 21:33:35 -05:00
Sundar Raman 94692607e6 Documentation on how to use external debuggers like eclipse/aptana 2012-01-16 13:42:43 -05:00
Armin Ronacher f64098c784 Merge pull request #369 from FND/docs
documentation: stylistic adjustments
2012-01-04 15:05:16 -08:00
Armin Ronacher 065afe53a6 Improved doc exaples. This fixes #370 and #371. 2011-12-27 19:08:44 +01:00
FND 7ccca13bbd Fixed various stylistic issues in documentation 2011-12-27 11:01:14 +01:00
Craig Dennis 75050d4bc5 Simple documentation corrections, mostly typos. 2011-11-20 17:03:37 +01:00
Armin Ronacher b40af3ccd9 Updated the documentation to show how to set cookies for not yet existing responses 2011-09-05 18:51:47 +02:00
Armin Ronacher 5b16532000 Extended quickstart docs for the headers 2011-08-07 16:21:58 +02:00
Armin Ronacher 13005d76b9 Improved cookie documentation 2011-08-07 15:23:57 +02:00
Kenneth Reitz a7b85c9f15 Consistent quotes 2011-07-29 09:54:50 -03:00
Armin Ronacher 22d468e190 Less annoying gender neutral forms 2011-06-28 14:34:07 +02:00
Armin Ronacher 4e47ea9105 Merge branch 'master' into blueprints 2011-06-27 09:30:39 +02:00
Jeffrey Finkelstein 12761bd02c fixed pronoun gender in documentation 2011-06-26 21:43:48 -04:00
Armin Ronacher 3add9c5fc2 Merge branch 'master' into blueprints 2011-06-20 08:44:02 +02:00
Armin Ronacher 86175054d6 More docstrings for blueprints. 2011-06-17 20:27:25 +02:00
Kenneth Reitz 87234fb2f8 fixed typo 2011-06-15 23:31:48 -07:00