autoDocstring icon indicating copy to clipboard operation
autoDocstring copied to clipboard

Return docstring generated for internal function

Open zgoda opened this issue 4 years ago • 1 comments

def configure_extensions(app: Application):
    """Register and configure framework extensions.

    :param app: application object
    :type app: Application
    :return: [description]
    :rtype: [type]
    """
    babel.init_app(app)
    csrf.init_app(app)
    bootstrap.init_app(app)

    login_manager.init_app(app)
    login_manager.login_view = 'auth.login'
    login_manager.login_message_category = 'warning'
    login_manager.login_message = 'Authenticate to access this page'

    @login_manager.user_loader
    def get_user(userid: str) -> bool:  # pylint: disable=unused-variable
        return User.get_or_none(User.pk == userid)

The above function does not return anything, I believe the return fields in docstring are wrongly generated for internal function.

zgoda avatar Apr 17 '20 08:04 zgoda

Good catch. This is indeed a bug. Will fix in the next version.

NilsJPWerner avatar Apr 23 '20 18:04 NilsJPWerner