update docstrings

Author: geritwagner

colrev/loader/md.py

@@ -33,7 +33,7 @@ def __init__(
         logger: logging.Logger = logging.getLogger(__name__),
         format_names: bool = False,
     ):
-
+        """Initialize the markdown loader."""
         super().__init__(
             filename=filename,
             id_labeler=id_labeler,

colrev/ops/clone.py

@@ -18,6 +18,7 @@ class Clone:
     # pylint: disable=too-few-public-methods
 
     def __init__(self, *, git_url: str) -> None:
+        """Initialize the clone operation."""
         self.git_url = git_url
         """The git remote URL"""
 

colrev/packages/plos/src/plos_search_source.py

@@ -48,6 +48,7 @@ def __init__(
         logger: typing.Optional[logging.Logger] = None,
         verbose_mode: bool = False,
     ) -> None:
+        """Initialize the PLOS search source."""
         self.logger = logger or logging.getLogger(__name__)
         self.verbose_mode = verbose_mode
 
@@ -83,7 +84,8 @@ def add_endpoint(
         path: Path,
         logger: typing.Optional[logging.Logger] = None,
     ) -> colrev.search_file.ExtendedSearchFile:
-        """Add the SearchSource as an endpoint based on a query (passed to colrev search -a)
+        """Add the SearchSource as an endpoint based on a query.
+
         params:
         - search_file="..." to add a DB search.
         """

colrev/record/qm/checkers/incomplete_field.py

@@ -19,6 +19,7 @@ class IncompleteFieldChecker:
     def __init__(
         self, quality_model: colrev.record.qm.quality_model.QualityModel
     ) -> None:
+        """Initialize the checker."""
         self.quality_model = quality_model
 
     def run(self, *, record: colrev.record.record.Record) -> None:
@@ -65,6 +66,7 @@ def _incomplete_field(
     def _institutional_author(
         self, *, key: str, record: colrev.record.record.Record
     ) -> bool:
+        """Determine whether the author field contains an institutional author."""
         if key != Fields.AUTHOR or Fields.AUTHOR not in record.data:
             return False
         if record.data[Fields.AUTHOR].startswith("{") and record.data[

colrev/ui_cli/detect_and_add_source.py

@@ -22,6 +22,7 @@ class CLISourceAdder:
     """CLI utility to add SearchSources."""
 
     def __init__(self, *, search_operation: colrev.ops.search.Search) -> None:
+        """Initialize the source adder."""
         self.search_operation = search_operation
         self.review_manager = search_operation.review_manager
         self.package_manager = PackageManager()