docs: update doc strings
This commit is contained in:
parent
78fb13fb26
commit
016d7db63e
@ -152,7 +152,7 @@ class MediaRepository:
|
||||
|
||||
Args:
|
||||
media_path: Path to media storage directory
|
||||
connection_string: PostgreSQL connection string
|
||||
connection_strings: Dictionary of db connection strings
|
||||
|
||||
Raises:
|
||||
ValueError: If media_path doesn't exist or connection string is invalid
|
||||
@ -191,6 +191,9 @@ class MediaRepository:
|
||||
def connect_db(self, connection_string: str) -> DBConnection:
|
||||
"""Establish database connection.
|
||||
|
||||
Args:
|
||||
connection_string: db connection string
|
||||
|
||||
Returns:
|
||||
PostgreSQL connection object
|
||||
|
||||
@ -317,7 +320,7 @@ def read_config(conf_file: Union[str, Path]) -> Tuple[Path, dict[str, str]]:
|
||||
conf_file: Path to Dendrite YAML config file
|
||||
|
||||
Returns:
|
||||
Tuple of (media_path, connection_string)
|
||||
Tuple of (media_path, connection_strings)
|
||||
|
||||
Raises:
|
||||
SystemExit: If config file is invalid or missing required fields
|
||||
|
Loading…
x
Reference in New Issue
Block a user