Skip to content

Commit bdbca92

Browse files
Sanjurjo7davidism
authored andcommitted
Addressing Issue 1809 (pallets#1811)
document kwargs for Flask.register_blueprint
1 parent 883cb7c commit bdbca92

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

flask/app.py

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -934,7 +934,22 @@ def make_null_session(self):
934934

935935
@setupmethod
936936
def register_blueprint(self, blueprint, **options):
937-
"""Registers a blueprint on the application.
937+
"""Register a blueprint on the application. For information about
938+
blueprints head over to :ref:`blueprints`.
939+
940+
The blueprint name is passed in as the first argument.
941+
Options are passed as additional keyword arguments and forwarded to
942+
`blueprints` in an "options" dictionary.
943+
944+
:param subdomain: set a subdomain for the blueprint
945+
:param url_prefix: set the prefix for all URLs defined on the blueprint.
946+
``(url_prefix='/<lang code>')``
947+
:param url_defaults: a dictionary with URL defaults that is added to
948+
each and every URL defined with this blueprint
949+
:param static_folder: add a static folder to urls in this blueprint
950+
:param static_url_path: add a static url path to urls in this blueprint
951+
:param template_folder: set an alternate template folder
952+
:param root_path: set an alternate root path for this blueprint
938953
939954
.. versionadded:: 0.7
940955
"""

0 commit comments

Comments
 (0)