Improve documentation
This commit is contained in:
		@@ -67,9 +67,11 @@ class Application(
 | 
			
		||||
    """WSGI application."""
 | 
			
		||||
 | 
			
		||||
    def __init__(self, configuration):
 | 
			
		||||
        """Initialize application.
 | 
			
		||||
        """Initialize Application.
 | 
			
		||||
 | 
			
		||||
        ``configuration`` see ``radicale.config`` module.
 | 
			
		||||
        The ``configuration`` must not change during the lifetime of
 | 
			
		||||
        this object, it is kept as an internal reference.
 | 
			
		||||
 | 
			
		||||
        """
 | 
			
		||||
        super().__init__()
 | 
			
		||||
 
 | 
			
		||||
@@ -53,6 +53,13 @@ def load(configuration):
 | 
			
		||||
 | 
			
		||||
class BaseAuth:
 | 
			
		||||
    def __init__(self, configuration):
 | 
			
		||||
        """Initialize BaseAuth.
 | 
			
		||||
 | 
			
		||||
        ``configuration`` see ``radicale.config`` module.
 | 
			
		||||
        The ``configuration`` must not change during the lifetime of
 | 
			
		||||
        this object, it is kept as an internal reference.
 | 
			
		||||
 | 
			
		||||
        """
 | 
			
		||||
        self.configuration = configuration
 | 
			
		||||
 | 
			
		||||
    def get_external_login(self, environ):
 | 
			
		||||
 
 | 
			
		||||
@@ -294,6 +294,8 @@ class Configuration:
 | 
			
		||||
 | 
			
		||||
        ``schema`` a dict that describes the configuration format.
 | 
			
		||||
        See ``DEFAULT_CONFIG_SCHEMA``.
 | 
			
		||||
        The content of ``schema`` must not change afterwards, it is kept
 | 
			
		||||
        as an internal reference.
 | 
			
		||||
 | 
			
		||||
        Use ``load()`` to create an instance for use with
 | 
			
		||||
        ``radicale.app.Application``.
 | 
			
		||||
@@ -316,6 +318,8 @@ class Configuration:
 | 
			
		||||
 | 
			
		||||
        ``config`` a dict of the format {SECTION: {OPTION: VALUE, ...}, ...}.
 | 
			
		||||
        The configuration is checked for errors according to the config schema.
 | 
			
		||||
        The content of ``config`` must not change afterwards, it is kept
 | 
			
		||||
        as an internal reference.
 | 
			
		||||
 | 
			
		||||
        ``source`` a description of the configuration source (used in error
 | 
			
		||||
        messages).
 | 
			
		||||
 
 | 
			
		||||
@@ -59,6 +59,13 @@ def intersect_permissions(a, b="RrWw"):
 | 
			
		||||
 | 
			
		||||
class BaseRights:
 | 
			
		||||
    def __init__(self, configuration):
 | 
			
		||||
        """Initialize BaseRights.
 | 
			
		||||
 | 
			
		||||
        ``configuration`` see ``radicale.config`` module.
 | 
			
		||||
        The ``configuration`` must not change during the lifetime of
 | 
			
		||||
        this object, it is kept as an internal reference.
 | 
			
		||||
 | 
			
		||||
        """
 | 
			
		||||
        self.configuration = configuration
 | 
			
		||||
 | 
			
		||||
    def authorized(self, user, path, permissions):
 | 
			
		||||
 
 | 
			
		||||
@@ -46,6 +46,13 @@ def load(configuration):
 | 
			
		||||
 | 
			
		||||
class BaseWeb:
 | 
			
		||||
    def __init__(self, configuration):
 | 
			
		||||
        """Initialize BaseWeb.
 | 
			
		||||
 | 
			
		||||
        ``configuration`` see ``radicale.config`` module.
 | 
			
		||||
        The ``configuration`` must not change during the lifetime of
 | 
			
		||||
        this object, it is kept as an internal reference.
 | 
			
		||||
 | 
			
		||||
        """
 | 
			
		||||
        self.configuration = configuration
 | 
			
		||||
 | 
			
		||||
    def get(self, environ, base_prefix, path, user):
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user