Documentation changes

This commit is contained in:
Ege Emir Özkan
2020-08-23 15:46:24 +03:00
parent dbaf88212a
commit a4693c3170

View File

@@ -1,7 +1,7 @@
""" """
This module includes functions to insert multiple records This module includes functions to insert multiple records
to a bound database at one time, with one time open and closing to a bound database at one time, with one time open and closing
of the database file. of the database file.
""" """
from typing import TypeVar, Union, List, Tuple from typing import TypeVar, Union, List, Tuple
from dataclasses import asdict from dataclasses import asdict
@@ -15,7 +15,7 @@ T = TypeVar('T')
class HeterogeneousCollectionError(Exception): class HeterogeneousCollectionError(Exception):
""" """
:raises if the passed collection is not homogeneous. :raise : if the passed collection is not homogeneous.
ie: If a List or Tuple has elements of multiple ie: If a List or Tuple has elements of multiple
types. types.
""" """
@@ -106,8 +106,8 @@ def create_many(objects: Union[List[T], Tuple[T]], protect_memory: bool = True)
def copy_many(objects: Union[List[T], Tuple[T]], db_name: str, protect_memory: bool = True) -> None: def copy_many(objects: Union[List[T], Tuple[T]], db_name: str, protect_memory: bool = True) -> None:
""" """
Copy many records to another database, from Copy many records to another database, from
their original database to new database, their original database to new database, do
do not delete old records. not delete old records.
:param objects: Objects to copy. :param objects: Objects to copy.
:param db_name: Name of the new database. :param db_name: Name of the new database.