forked from orbit-oss/flask
Fix some typos in the docstrings
This commit is contained in:
parent
ff2786d8af
commit
549af62290
4 changed files with 8 additions and 8 deletions
|
|
@ -215,7 +215,7 @@ class Flask(_PackageBoundObject):
|
||||||
#: A dictionary of all view functions registered. The keys will
|
#: A dictionary of all view functions registered. The keys will
|
||||||
#: be function names which are also used to generate URLs and
|
#: be function names which are also used to generate URLs and
|
||||||
#: the values are the function objects themselves.
|
#: the values are the function objects themselves.
|
||||||
#: to register a view function, use the :meth:`route` decorator.
|
#: To register a view function, use the :meth:`route` decorator.
|
||||||
self.view_functions = {}
|
self.view_functions = {}
|
||||||
|
|
||||||
#: A dictionary of all registered error handlers. The key is
|
#: A dictionary of all registered error handlers. The key is
|
||||||
|
|
@ -242,7 +242,7 @@ class Flask(_PackageBoundObject):
|
||||||
self.after_request_funcs = {}
|
self.after_request_funcs = {}
|
||||||
|
|
||||||
#: A dictionary with list of functions that are called without argument
|
#: A dictionary with list of functions that are called without argument
|
||||||
#: to populate the template context. They key of the dictionary is the
|
#: to populate the template context. The key of the dictionary is the
|
||||||
#: name of the module this function is active for, `None` for all
|
#: name of the module this function is active for, `None` for all
|
||||||
#: requests. Each returns a dictionary that the template context is
|
#: requests. Each returns a dictionary that the template context is
|
||||||
#: updated with. To register a function here, use the
|
#: updated with. To register a function here, use the
|
||||||
|
|
|
||||||
|
|
@ -146,7 +146,7 @@ def url_for(endpoint, **values):
|
||||||
"""Generates a URL to the given endpoint with the method provided.
|
"""Generates a URL to the given endpoint with the method provided.
|
||||||
The endpoint is relative to the active module if modules are in use.
|
The endpoint is relative to the active module if modules are in use.
|
||||||
|
|
||||||
Here some examples:
|
Here are some examples:
|
||||||
|
|
||||||
==================== ======================= =============================
|
==================== ======================= =============================
|
||||||
Active Module Target Endpoint Target Function
|
Active Module Target Endpoint Target Function
|
||||||
|
|
|
||||||
|
|
@ -54,7 +54,7 @@ class Module(_PackageBoundObject):
|
||||||
to be provided to keep them apart. If different import names are used,
|
to be provided to keep them apart. If different import names are used,
|
||||||
the rightmost part of the import name is used as name.
|
the rightmost part of the import name is used as name.
|
||||||
|
|
||||||
Here an example structure for a larger appliation::
|
Here's an example structure for a larger application::
|
||||||
|
|
||||||
/myapplication
|
/myapplication
|
||||||
/__init__.py
|
/__init__.py
|
||||||
|
|
@ -73,7 +73,7 @@ class Module(_PackageBoundObject):
|
||||||
app.register_module(admin, url_prefix='/admin')
|
app.register_module(admin, url_prefix='/admin')
|
||||||
app.register_module(frontend)
|
app.register_module(frontend)
|
||||||
|
|
||||||
And here an example view module (`myapplication/views/admin.py`)::
|
And here's an example view module (`myapplication/views/admin.py`)::
|
||||||
|
|
||||||
from flask import Module
|
from flask import Module
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -17,7 +17,7 @@ from .globals import _request_ctx_stack
|
||||||
|
|
||||||
|
|
||||||
class Request(RequestBase):
|
class Request(RequestBase):
|
||||||
"""The request object used by default in flask. Remembers the
|
"""The request object used by default in Flask. Remembers the
|
||||||
matched endpoint and view arguments.
|
matched endpoint and view arguments.
|
||||||
|
|
||||||
It is what ends up as :class:`~flask.request`. If you want to replace
|
It is what ends up as :class:`~flask.request`. If you want to replace
|
||||||
|
|
@ -77,8 +77,8 @@ class Request(RequestBase):
|
||||||
|
|
||||||
|
|
||||||
class Response(ResponseBase):
|
class Response(ResponseBase):
|
||||||
"""The response object that is used by default in flask. Works like the
|
"""The response object that is used by default in Flask. Works like the
|
||||||
response object from Werkzeug but is set to have a HTML mimetype by
|
response object from Werkzeug but is set to have an HTML mimetype by
|
||||||
default. Quite often you don't have to create this object yourself because
|
default. Quite often you don't have to create this object yourself because
|
||||||
:meth:`~flask.Flask.make_response` will take care of that for you.
|
:meth:`~flask.Flask.make_response` will take care of that for you.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue