adding docstrings

alan-turing-institute · Sep 18, 2024 · 6d19093 · 6d19093
1 parent 86c0d2a
commit 6d19093
Show file tree

Hide file tree

Showing 4 changed files with 632 additions and 37 deletions.
diff --git a/art/classes/__pycache__/authors.cpython-39.pyc b/art/classes/__pycache__/authors.cpython-39.pyc
diff --git a/art/classes/authors.py b/art/classes/authors.py
@@ -400,7 +400,7 @@ def name_set(self) -> set:
     def has_orcid(self) -> bool:
 
         """
-        Returns True if the Author has an Orcid ID associated.
+        Returns True if the Author has an Orcid ID associated. Else, returns False.
         """
 
         orcid = self.summary.loc[0, 'orcid']
@@ -465,7 +465,7 @@ def add_dataframe(self, dataframe: pd.DataFrame):
     def from_dataframe(dataframe: pd.DataFrame): # type: ignore
 
         """
-        Takes a Pandas DataFrame and returns an Author.
+        Takes a Pandas DataFrame and returns an Author object.
 
         Parameters
         ----------
@@ -728,7 +728,7 @@ def update_from_orcid(self):
 class Authors(Entities):
 
     """
-    This is an Authors object. It contains a collection of Authors objects and a summary of data about them.
+    This is an Authors object. It contains a collection of Author objects and a summary of data about them.
     
     Parameters
     ----------
@@ -822,7 +822,7 @@ def __repr__(self) -> str:
     def __len__(self) -> int:
 
         """
-        Returns the number of Authors in the Authors collection. Uses the number of Author objects stored in the Authors.all dictionary.
+        Returns the number of Author objects in the Authors collection. Uses the number of Author objects stored in the Authors.all dictionary.
 
         Returns
         -------
@@ -886,6 +886,7 @@ def merge(self, authors, drop_duplicates = False, drop_empty_rows=False):
         self : Authors
             the merged Authors collection.
         """
+
         left = self.summary.copy(deep=True)
         right = authors.summary.copy(deep=True)
 
@@ -1508,12 +1509,12 @@ def search_orcid(self, query: str = 'request_input', add_to_authors: bool = True
 def format_authors(author_data, drop_duplicates = False, drop_empty_rows=False):
 
         """
-        Formats a collection of author data as an Authors object.
+        Formats a collection of authors data as an Authors object.
 
         Parameters
         ----------
         author_data : object
-            a collection of author data.
+            a collection of authors data.
         drop_empty_rows : bool
             whether to remove rows which do not contain any data. Defaults to False.
         drop_duplicates : bool