remove unused module docstrings

src/flask/__init__.py

@@ -1,15 +1,3 @@
-"""
-    flask
-    ~~~~~
-
-    A microframework based on Werkzeug.  It's extensively documented
-    and follows best practice patterns.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
-# utilities we import from Werkzeug and Jinja2 that are unused
-# in the module but are exported as public interface.
 from jinja2 import escape
 from jinja2 import Markup
 from werkzeug.exceptions import abort

src/flask/__main__.py

@@ -1,14 +1,3 @@
-"""
+from .cli import main
-    flask.__main__
-    ~~~~~~~~~~~~~~
 
-    Alias for flask.run for the command line.
+main(as_module=True)
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
-
-if __name__ == "__main__":
-    from .cli import main
-
-    main(as_module=True)

src/flask/app.py

@@ -1,12 +1,3 @@
-"""
-    flask.app
-    ~~~~~~~~~
-
-    This module implements the central WSGI application object.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import os
 import sys
 from datetime import timedelta

src/flask/blueprints.py

@@ -1,13 +1,3 @@
-"""
-    flask.blueprints
-    ~~~~~~~~~~~~~~~~
-
-    Blueprints are the recommended way to implement larger or more
-    pluggable applications in Flask 0.7 and later.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from functools import update_wrapper
 
 from .helpers import _endpoint_from_view_func

src/flask/cli.py

@@ -1,12 +1,3 @@
-"""
-    flask.cli
-    ~~~~~~~~~
-
-    A simple command line application to run flask apps.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import ast
 import inspect
 import os

src/flask/config.py

@@ -1,12 +1,3 @@
-"""
-    flask.config
-    ~~~~~~~~~~~~
-
-    Implements the configuration related objects.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import errno
 import os
 import types

src/flask/ctx.py

@@ -1,12 +1,3 @@
-"""
-    flask.ctx
-    ~~~~~~~~~
-
-    Implements the objects required to keep the context.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import sys
 from functools import update_wrapper
 

src/flask/debughelpers.py

@@ -1,12 +1,3 @@
-"""
-    flask.debughelpers
-    ~~~~~~~~~~~~~~~~~~
-
-    Various helpers to make the development experience better.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import os
 from warnings import warn
 

src/flask/globals.py

@@ -1,13 +1,3 @@
-"""
-    flask.globals
-    ~~~~~~~~~~~~~
-
-    Defines all the global objects that are proxies to the current
-    active context.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from functools import partial
 
 from werkzeug.local import LocalProxy

src/flask/helpers.py

@@ -1,12 +1,3 @@
-"""
-    flask.helpers
-    ~~~~~~~~~~~~~
-
-    Implements various helpers.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import io
 import mimetypes
 import os

src/flask/json/__init__.py

@@ -1,10 +1,3 @@
-"""
-flask.json
-~~~~~~~~~~
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
-"""
 import codecs
 import io
 import uuid

src/flask/json/tag.py

@@ -2,10 +2,10 @@
 Tagged JSON
 ~~~~~~~~~~~
 
-A compact representation for lossless serialization of non-standard JSON types.
+A compact representation for lossless serialization of non-standard JSON
-:class:`~flask.sessions.SecureCookieSessionInterface` uses this to serialize
+types. :class:`~flask.sessions.SecureCookieSessionInterface` uses this
-the session data, but it may be useful in other places. It can be extended to
+to serialize the session data, but it may be useful in other places. It
-support other types.
+can be extended to support other types.
 
 .. autoclass:: TaggedJSONSerializer
     :members:
@@ -13,12 +13,15 @@ support other types.
 .. autoclass:: JSONTag
     :members:
 
-Let's seen an example that adds support for :class:`~collections.OrderedDict`.
+Let's see an example that adds support for
-Dicts don't have an order in Python or JSON, so to handle this we will dump
+:class:`~collections.OrderedDict`. Dicts don't have an order in JSON, so
-the items as a list of ``[key, value]`` pairs. Subclass :class:`JSONTag` and
+to handle this we will dump the items as a list of ``[key, value]``
-give it the new key ``' od'`` to identify the type. The session serializer
+pairs. Subclass :class:`JSONTag` and give it the new key ``' od'`` to
-processes dicts first, so insert the new tag at the front of the order since
+identify the type. The session serializer processes dicts first, so
-``OrderedDict`` must be processed before ``dict``. ::
+insert the new tag at the front of the order since ``OrderedDict`` must
+be processed before ``dict``.
+
+.. code-block:: python
 
     from flask.json.tag import JSONTag
 
@@ -36,9 +39,6 @@ processes dicts first, so insert the new tag at the front of the order since
             return OrderedDict(value)
 
     app.session_interface.serializer.register(TagOrderedDict, index=0)
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
 """
 from base64 import b64decode
 from base64 import b64encode

src/flask/logging.py

@@ -1,10 +1,3 @@
-"""
-flask.logging
-~~~~~~~~~~~~~
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
-"""
 import logging
 import sys
 

src/flask/sessions.py

@@ -1,12 +1,3 @@
-"""
-    flask.sessions
-    ~~~~~~~~~~~~~~
-
-    Implements cookie based sessions based on itsdangerous.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import hashlib
 import warnings
 from collections.abc import MutableMapping

src/flask/signals.py

@@ -1,13 +1,3 @@
-"""
-    flask.signals
-    ~~~~~~~~~~~~~
-
-    Implements signals based on blinker if available, otherwise
-    falls silently back to a noop.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 try:
     from blinker import Namespace
 

src/flask/templating.py

@@ -1,12 +1,3 @@
-"""
-    flask.templating
-    ~~~~~~~~~~~~~~~~
-
-    Implements the bridge to Jinja2.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from jinja2 import BaseLoader
 from jinja2 import Environment as BaseEnvironment
 from jinja2 import TemplateNotFound

src/flask/testing.py

@@ -1,13 +1,3 @@
-"""
-    flask.testing
-    ~~~~~~~~~~~~~
-
-    Implements test support helpers.  This module is lazily imported
-    and usually not used in production environments.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from contextlib import contextmanager
 
 import werkzeug.test

src/flask/views.py

@@ -1,12 +1,3 @@
-"""
-    flask.views
-    ~~~~~~~~~~~
-
-    This module provides class-based views inspired by the ones in Django.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from .globals import request
 
 

src/flask/wrappers.py

@@ -1,12 +1,3 @@
-"""
-    flask.wrappers
-    ~~~~~~~~~~~~~~
-
-    Implements the WSGI wrappers (request and response).
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from werkzeug.exceptions import BadRequest
 from werkzeug.wrappers import Request as RequestBase
 from werkzeug.wrappers import Response as ResponseBase

tests/conftest.py

@@ -1,10 +1,3 @@
-"""
-    tests.conftest
-    ~~~~~~~~~~~~~~
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import os
 import pkgutil
 import sys

tests/test_appctx.py

@@ -1,12 +1,3 @@
-"""
-    tests.appctx
-    ~~~~~~~~~~~~
-
-    Tests the application context.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import pytest
 
 import flask

tests/test_basic.py

@@ -1,12 +1,3 @@
-"""
-    tests.basic
-    ~~~~~~~~~~~~~~~~~~~~~
-
-    The basic functionality.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import re
 import sys
 import time

tests/test_blueprints.py

@@ -1,12 +1,3 @@
-"""
-    tests.blueprints
-    ~~~~~~~~~~~~~~~~
-
-    Blueprints (and currently modules)
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import functools
 
 import pytest

tests/test_cli.py

@@ -1,10 +1,3 @@
-"""
-    tests.test_cli
-    ~~~~~~~~~~~~~~
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 # This file was part of Flask-CLI and was modified under the terms of
 # its Revised BSD License. Copyright © 2015 CERN.
 import os

tests/test_config.py

@@ -1,10 +1,3 @@
-"""
-    tests.test_config
-    ~~~~~~~~~~~~~~~~~
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import json
 import os
 import textwrap

tests/test_helpers.py

@@ -1,12 +1,3 @@
-"""
-    tests.helpers
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Various helpers.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import datetime
 import io
 import os

tests/test_instance_config.py

@@ -1,10 +1,3 @@
-"""
-    tests.test_instance
-    ~~~~~~~~~~~~~~~~~~~
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import os
 import sys
 

tests/test_json_tag.py

@@ -1,10 +1,3 @@
-"""
-tests.test_json_tag
-~~~~~~~~~~~~~~~~~~~
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
-"""
 from datetime import datetime
 from uuid import uuid4
 

tests/test_logging.py

@@ -1,10 +1,3 @@
-"""
-tests.test_logging
-~~~~~~~~~~~~~~~~~~~
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
-"""
 import logging
 import sys
 from io import StringIO

tests/test_regression.py

@@ -1,12 +1,3 @@
-"""
-    tests.regression
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Tests regressions.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import gc
 import platform
 import threading

tests/test_reqctx.py

@@ -1,12 +1,3 @@
-"""
-    tests.reqctx
-    ~~~~~~~~~~~~
-
-    Tests the request context.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import pytest
 
 import flask

tests/test_signals.py

@@ -1,12 +1,3 @@
-"""
-    tests.signals
-    ~~~~~~~~~~~~~~~~~~~~~~~
-
-    Signalling.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import pytest
 
 try:

tests/test_subclassing.py

@@ -1,13 +1,3 @@
-"""
-    tests.subclassing
-    ~~~~~~~~~~~~~~~~~
-
-    Test that certain behavior of flask can be customized by
-    subclasses.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 from io import StringIO
 
 import flask

tests/test_templating.py

@@ -1,12 +1,3 @@
-"""
-    tests.templating
-    ~~~~~~~~~~~~~~~~
-
-    Template functionality
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import logging
 
 import pytest

tests/test_testing.py

@@ -1,12 +1,3 @@
-"""
-    tests.testing
-    ~~~~~~~~~~~~~
-
-    Test client and more.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import click
 import pytest
 import werkzeug

tests/test_user_error_handler.py

@@ -1,10 +1,3 @@
-"""
-tests.test_user_error_handler
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-:copyright: 2010 Pallets
-:license: BSD-3-Clause
-"""
 import pytest
 from werkzeug.exceptions import Forbidden
 from werkzeug.exceptions import HTTPException

tests/test_views.py

@@ -1,12 +1,3 @@
-"""
-    tests.views
-    ~~~~~~~~~~~
-
-    Pluggable views.
-
-    :copyright: 2010 Pallets
-    :license: BSD-3-Clause
-"""
 import pytest
 from werkzeug.http import parse_set_header