Docstrings update

materialsproject · May 11, 2021 · 77ae453 · 77ae453
1 parent c58eec6
commit 77ae453
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 12 deletions.
diff --git a/src/mp_api/routes/eos/client.py b/src/mp_api/routes/eos/client.py
@@ -31,9 +31,8 @@ def search_eos_docs(
             fields (List[str]): List of fields in EOSDoc to return data for.
                 Default is material_id only.
 
-        Yields:
-            ([dict]) List of dictionaries containing data for entries defined in 'fields'.
-                Defaults to Materials Project IDs only.
+        Returns:
+            ([EOSDoc]) List of eos documents
         """
 
         query_params = defaultdict(dict)  # type: dict

diff --git a/src/mp_api/routes/grain_boundary/client.py b/src/mp_api/routes/grain_boundary/client.py
@@ -43,9 +43,8 @@ def search_grain_boundary_docs(
             fields (List[str]): List of fields in GrainBoundaryDoc to return data for.
                 Default is material_id only.
 
-        Yields:
-            ([dict]) List of dictionaries containing data for entries defined in 'fields'.
-                Defaults to Materials Project IDs and last updated data.
+       Returns:
+            ([GrainBoundaryDoc]) List of grain boundary documents
         """
 
         query_params = defaultdict(dict)  # type: dict

diff --git a/src/mp_api/routes/magnetism/client.py b/src/mp_api/routes/magnetism/client.py
@@ -48,9 +48,8 @@ def search_magnetism_docs(
             fields (List[str]): List of fields in MagnetismDoc to return data for.
                 Default is material_id only.
 
-        Yields:
-            ([dict]) List of dictionaries containing data for entries defined in 'fields'.
-                Defaults to Materials Project IDs only.
+        Returns:
+            ([MagnetismDoc]) List of magnetism documents
         """
 
         query_params = defaultdict(dict)  # type: dict

diff --git a/src/mp_api/routes/materials/client.py b/src/mp_api/routes/materials/client.py
@@ -72,9 +72,8 @@ def search_material_docs(
             fields (List[str]): List of fields in MaterialsCoreDoc to return data for.
                 Default is material_id, last_updated, and formula_pretty.
 
-        Yields:
-            ([dict]) List of dictionaries containing data for entries defined in 'fields'.
-                Defaults to Materials Project IDs reduced chemical formulas, and last updated tags.
+        Returns:
+            ([MaterialsDoc]) List of material documents
         """
 
         query_params = {"deprecated": deprecated}  # type: dict