Skip to content

Commit

Permalink
Consistent docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
Lxstr committed Feb 23, 2024
1 parent 68e8ed6 commit 431debd
Show file tree
Hide file tree
Showing 5 changed files with 9 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/flask_session/cachelib/cachelib.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/flask_session/filesystem/filesystem.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/flask_session/mongodb/mongodb.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/flask_session/redis/redis.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions src/flask_session/sqlalchemy/sqlalchemy.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 431debd

Please sign in to comment.