Merge pull request lightspeed-core#718 from tisnik/lcore-632-updated-source

LCORE-632: updated source doc

Author: tisnik

src/quota/README.md

@@ -3,6 +3,30 @@
 ## [__init__.py](__init__.py)
 Quota management.
 
+## [cluster_quota_limiter.py](cluster_quota_limiter.py)
+Simple cluster quota limiter where quota is fixed for the whole cluster.
+
+## [connect_pg.py](connect_pg.py)
+PostgreSQL connection handler.
+
+## [connect_sqlite.py](connect_sqlite.py)
+SQLite connection handler.
+
+## [quota_exceed_error.py](quota_exceed_error.py)
+Any exception that can occur when a user does not have enough tokens available.
+
+## [quota_limiter.py](quota_limiter.py)
+Abstract class that is the parent for all quota limiter implementations.
+
+## [quota_limiter_factory.py](quota_limiter_factory.py)
+Quota limiter factory class.
+
+## [revokable_quota_limiter.py](revokable_quota_limiter.py)
+Simple quota limiter where quota can be revoked.
+
 ## [sql.py](sql.py)
 SQL commands used by quota management package.
 
+## [user_quota_limiter.py](user_quota_limiter.py)
+Simple user quota limiter where each user has a fixed quota.
+

src/quota/quota_exceed_error.py

@@ -1,10 +1,10 @@
-"""Any exception that can occur when user does not have enough tokens available."""
+"""Any exception that can occur when a user does not have enough tokens available."""
 
-# pylint: disable=line-too-long)
+# pylint: disable=line-too-long
 
 
 class QuotaExceedError(Exception):
-    """Any exception that can occur when user does not have enough tokens available."""
+    """Any exception that can occur when a user does not have enough tokens available."""
 
     def __init__(
         self, subject_id: str, subject_type: str, available: int, needed: int = 0

src/quota/quota_limiter.py

@@ -1,4 +1,4 @@
-"""Abstract class that is parent for all quota limiter implementations."""
+"""Abstract class that is the parent for all quota limiter implementations."""
 
 from abc import ABC, abstractmethod
 

src/quota/user_quota_limiter.py

@@ -1,4 +1,4 @@
-"""Simple user quota limiter where each user have fixed quota."""
+"""Simple user quota limiter where each user has a fixed quota."""
 
 from models.config import QuotaHandlersConfiguration
 from log import get_logger