From 431debd85682efc11733d2ad376404479c445b02 Mon Sep 17 00:00:00 2001 From: Lex Date: Sat, 24 Feb 2024 00:20:00 +1000 Subject: [PATCH] Consistent docstrings --- src/flask_session/cachelib/cachelib.py | 2 +- src/flask_session/filesystem/filesystem.py | 2 +- src/flask_session/mongodb/mongodb.py | 6 +++--- src/flask_session/redis/redis.py | 2 +- src/flask_session/sqlalchemy/sqlalchemy.py | 6 +++--- 5 files changed, 9 insertions(+), 9 deletions(-) diff --git a/src/flask_session/cachelib/cachelib.py b/src/flask_session/cachelib/cachelib.py index ad007d8e..ca2d453b 100644 --- a/src/flask_session/cachelib/cachelib.py +++ b/src/flask_session/cachelib/cachelib.py @@ -16,7 +16,7 @@ class CacheLibSessionInterface(ServerSideSessionInterface): """Uses any :class:`cachelib` backend as a session storage. :param client: A :class:`cachelib` backend instance. - :param key_prefix: A prefix that is added to store keys. + :param key_prefix: A prefix that is added to storage keys. :param use_signer: Whether to sign the session id cookie or not. :param permanent: Whether to use permanent session or not. :param sid_length: The length of the generated session id in bytes. diff --git a/src/flask_session/filesystem/filesystem.py b/src/flask_session/filesystem/filesystem.py index 919bb23f..70e13649 100644 --- a/src/flask_session/filesystem/filesystem.py +++ b/src/flask_session/filesystem/filesystem.py @@ -16,7 +16,7 @@ class FileSystemSession(ServerSideSession): class FileSystemSessionInterface(ServerSideSessionInterface): """Uses the :class:`cachelib.file.FileSystemCache` as a session storage. - :param key_prefix: A prefix that is added to FileSystemCache store keys. + :param key_prefix: A prefix that is added to stored keys. :param use_signer: Whether to sign the session id cookie or not. :param permanent: Whether to use permanent session or not. :param sid_length: The length of the generated session id in bytes. diff --git a/src/flask_session/mongodb/mongodb.py b/src/flask_session/mongodb/mongodb.py index cd5c37f8..45760cdb 100644 --- a/src/flask_session/mongodb/mongodb.py +++ b/src/flask_session/mongodb/mongodb.py @@ -17,13 +17,13 @@ class MongoDBSessionInterface(ServerSideSessionInterface): """A Session interface that uses mongodb as session storage. (`pymongo` required) :param client: A ``pymongo.MongoClient`` instance. - :param key_prefix: A prefix that is added to all MongoDB store keys. + :param key_prefix: A prefix that is added to all storage keys. :param use_signer: Whether to sign the session id cookie or not. :param permanent: Whether to use permanent session or not. :param sid_length: The length of the generated session id in bytes. :param serialization_format: The serialization format to use for the session data. - :param db: The database you want to use. - :param collection: The collection you want to use. + :param db: The database to use. + :param collection: The collection to use. .. versionadded:: 0.7 The `serialization_format` and `app` parameters were added. diff --git a/src/flask_session/redis/redis.py b/src/flask_session/redis/redis.py index 54961550..25bcff88 100644 --- a/src/flask_session/redis/redis.py +++ b/src/flask_session/redis/redis.py @@ -16,7 +16,7 @@ class RedisSessionInterface(ServerSideSessionInterface): """Uses the Redis key-value store as a session storage. (`redis-py` required) :param client: A ``redis.Redis`` instance. - :param key_prefix: A prefix that is added to all Redis store keys. + :param key_prefix: A prefix that is added to all storage keys. :param use_signer: Whether to sign the session id cookie or not. :param permanent: Whether to use permanent session or not. :param sid_length: The length of the generated session id in bytes. diff --git a/src/flask_session/sqlalchemy/sqlalchemy.py b/src/flask_session/sqlalchemy/sqlalchemy.py index 1ae2783d..ede2ace3 100644 --- a/src/flask_session/sqlalchemy/sqlalchemy.py +++ b/src/flask_session/sqlalchemy/sqlalchemy.py @@ -51,15 +51,15 @@ class SqlAlchemySessionInterface(ServerSideSessionInterface): :param app: A Flask app instance. :param client: A Flask-SQLAlchemy instance. - :param key_prefix: A prefix that is added to all store keys. + :param key_prefix: A prefix that is added to all storage keys. :param use_signer: Whether to sign the session id cookie or not. :param permanent: Whether to use permanent session or not. :param sid_length: The length of the generated session id in bytes. :param serialization_format: The serialization format to use for the session data. :param table: The table name you want to use. :param sequence: The sequence to use for the primary key if needed. - :param schema: The db schema to use - :param bind_key: The db bind key to use + :param schema: The db schema to use. + :param bind_key: The db bind key to use. :param cleanup_n_requests: Delete expired sessions on average every N requests. .. versionadded:: 1.0