Docstring updates

materialsproject · May 7, 2021 · e05e2e0 · e05e2e0
1 parent b2e9a20
commit e05e2e0
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 6 deletions.
diff --git a/src/mp_api/routes/dielectric/client.py b/src/mp_api/routes/dielectric/client.py
@@ -18,7 +18,7 @@ def search_dielectric_docs(
         n: Optional[Tuple[float, float]] = None,
         num_chunks: Optional[int] = None,
         chunk_size: int = 1000,
-        all_fields=True,
+        all_fields: bool = True,
         fields: Optional[List[str]] = None,
     ):
         """
@@ -35,7 +35,7 @@ def search_dielectric_docs(
             fields (List[str]): List of fields in EOSDoc to return data for.
                 Default is material_id and last_updated if all_fields is False.
 
-        Yields:
+        Returns:
             ([DielectricDoc]) List of dielectric documents.
         """
 

diff --git a/src/mp_api/routes/elasticity/client.py b/src/mp_api/routes/elasticity/client.py
@@ -24,7 +24,7 @@ def search_elasticity_docs(
         poisson_ratio: Optional[Tuple[float, float]] = None,
         num_chunks: Optional[int] = None,
         chunk_size: int = 1000,
-        all_fields=True,
+        all_fields: bool = True,
         fields: Optional[List[str]] = None,
     ):
         """
@@ -52,9 +52,8 @@ def search_elasticity_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:
+            ([ElasticityDoc]) List of elasticity documents.
         """
 
         query_params = defaultdict(dict)  # type: dict