Skip to content

Commit 034a50c

Browse files
committed
working on more helpful descriptions for flask code examples
1 parent 9e1a257 commit 034a50c

File tree

5 files changed

+28
-4
lines changed

5 files changed

+28
-4
lines changed

content/pages/examples/flask/flask-app-flask.markdown

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,12 @@ sidebartitle: flask.app Flask
77
meta: Python example code for the Flask class from the flask.app module of the Flask project.
88

99

10-
Flask is a class within the flask.app module of the Flask project.
10+
[Flask](https://github.com/pallets/flask/blob/master/src/flask/app.py) is
11+
a class within the flask.app module of the [Flask](/flask.html) framework
12+
that implements the [WSGI application specification](/wsgi-servers.html).
13+
This class acts as a central registry for a significant amount of a Flask
14+
application's functionality, including URL rounting,
15+
[template configurations](/template-engines.html), and handling view functions.
1116

1217

1318
## Example 1 from Braintree Flask app

content/pages/examples/flask/flask-app-headers.markdown

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,14 @@ sidebartitle: flask.app Headers
77
meta: Python example code for the Headers class from the flask.app module of the Flask project.
88

99

10-
Headers is a class within the flask.app module of the Flask project.
10+
[Headers](https://github.com/pallets/flask/blob/master/src/flask/app.py)
11+
is class within the flask.app module of the [Flask](/flask.html)
12+
[web framework](/web-frameworks.html) that is imported from the
13+
[datastructures](https://github.com/pallets/werkzeug/blob/master/src/werkzeug/datastructures.py)
14+
module of the [Werkzeug](https://palletsprojects.com/p/werkzeug/) project.
15+
Headers handles the
16+
[HTTP headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers)
17+
from requests and responses for Flask web applications.
1118

1219

1320
## Example 1 from flask-restx

content/pages/examples/flask/flask-blueprints-blueprint.markdown

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,10 @@ meta: Python example code for the Blueprint class from the flask.blueprints modu
99

1010
A Blueprint in [Flask](/flask.html) is
1111
[a "mold" or template for creating parts of web applications](https://stackoverflow.com/questions/24420857/what-are-flask-blueprints-exactly).
12+
This
13+
[Blueprint](https://github.com/pallets/flask/blob/master/src/flask/blueprints.py)
14+
class within the flask.blueprints module implements that functionality
15+
for Flask web apps.
1216

1317

1418
## Example 1 from Flask AppBuilder

content/pages/examples/flask/flask-cli-flaskgroup.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ sidebartitle: flask.cli FlaskGroup
77
meta: Python example code for the FlaskGroup class from the flask.cli module of the Flask project.
88

99

10-
FlaskGroup is a class within the flask.cli module of the Flask project.
10+
[FlaskGroup](https://github.com/pallets/flask/blob/master/src/flask/cli.py)
11+
is a class within the flask.cli module of the Flask project. FlaskGroup
12+
is a subclass of AppGroup that provides for loading more commands from
13+
a configured Flask app. Generally, only advanced use cases will need to
14+
use this class.
1115

1216

1317
## Example 1 from FlaskBB

content/pages/examples/flask/flask-cli-scriptinfo.markdown

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,11 @@ sidebartitle: flask.cli ScriptInfo
77
meta: Python example code for the ScriptInfo class from the flask.cli module of the Flask project.
88

99

10-
ScriptInfo is a class within the flask.cli module of the Flask project.
10+
[ScriptInfo](https://github.com/pallets/flask/blob/master/src/flask/cli.py)
11+
is a class within the flask.app module of the [Flask](/flask.html)
12+
framework. It is a helper object for Flask application and not usually
13+
dealt with directly by developers, instead it is created automatically
14+
by the [FlaskGroup](/flask-cli-flaskgroup-examples.html) object.
1115

1216

1317
## Example 1 from FlaskBB

0 commit comments

Comments
 (0)