fix docstrings to close #859

materialsproject · Dec 14, 2024 · 124f0b5 · 124f0b5
1 parent d8772dc
commit 124f0b5
Show file tree

Hide file tree

Showing 10 changed files with 11 additions and 11 deletions.
diff --git a/mp_api/client/routes/materials/summary.py b/mp_api/client/routes/materials/summary.py
@@ -76,8 +76,8 @@ def search(
 
         Arguments:
             band_gap (Tuple[float,float]): Minimum and maximum band gap in eV to consider.
-            chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-Fe-O, Si-*, [Si-O, Li-Fe-P]), or single formula (e.g., Fe2O3, Si*).
+            chemsys (str, List[str]): A chemical system or list of chemical systems
+                (e.g., Li-Fe-O, Si-*, [Si-O, Li-Fe-P]).
             crystal_system (CrystalSystem): Crystal system of material.
             density (Tuple[float,float]): Minimum and maximum density to consider.
             deprecated (bool): Whether the material is tagged as deprecated.

diff --git a/mp_api/client/routes/molecules/bonds.py b/mp_api/client/routes/molecules/bonds.py
@@ -55,7 +55,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
             chunk_size (int): Number of data entries per chunk.
             all_fields (bool): Whether to return all fields in the document. Defaults to True.

diff --git a/mp_api/client/routes/molecules/molecules.py b/mp_api/client/routes/molecules/molecules.py
@@ -125,7 +125,7 @@ def search(
             spin_multiplicity (Tuple[int, int]): Minimum and maximum spin for the molecule.
             nelements (Tuple[int, int]): Minimum and maximum number of elements
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             deprecated (bool): Whether the material is tagged as deprecated.
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.

diff --git a/mp_api/client/routes/molecules/orbitals.py b/mp_api/client/routes/molecules/orbitals.py
@@ -84,7 +84,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             electron_type_population (str): Should alpha ('alpha'), beta ('beta'), or all electrons (None) be
                 considered in a query of natural electron populations?
             core_electrons (Tuple[float, float]): Minimum and maximum number of core electrons in an atom

diff --git a/mp_api/client/routes/molecules/partial_charges.py b/mp_api/client/routes/molecules/partial_charges.py
@@ -49,7 +49,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
             chunk_size (int): Number of data entries per chunk.
             all_fields (bool): Whether to return all fields in the document. Defaults to True.

diff --git a/mp_api/client/routes/molecules/partial_spins.py b/mp_api/client/routes/molecules/partial_spins.py
@@ -49,7 +49,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
             chunk_size (int): Number of data entries per chunk.
             all_fields (bool): Whether to return all fields in the document. Defaults to True.

diff --git a/mp_api/client/routes/molecules/redox.py b/mp_api/client/routes/molecules/redox.py
@@ -57,7 +57,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             electrode (str): For redox potential queries, a string representation of the reference
                 electrode (currently accepted: "H", "Li", "Mg", "Ca")
             min_reduction_potential (float): Minimum reduction potential considered

diff --git a/mp_api/client/routes/molecules/summary.py b/mp_api/client/routes/molecules/summary.py
@@ -51,7 +51,7 @@ def search(
             #         "wB97X-V/def2-SVPD/SMD(SOLVENT=THF)",
             #         ["wB97X-V/def2-TZVPPD/SMD(VACUUM)", "wB97M-V/def2-QZVPPD/SMD(SOLVENT=WATER)"])
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             deprecated (bool): Whether the material is tagged as deprecated.
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.

diff --git a/mp_api/client/routes/molecules/thermo.py b/mp_api/client/routes/molecules/thermo.py
@@ -79,7 +79,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
             chunk_size (int): Number of data entries per chunk.
             all_fields (bool): Whether to return all fields in the document. Defaults to True.

diff --git a/mp_api/client/routes/molecules/vibrations.py b/mp_api/client/routes/molecules/vibrations.py
@@ -64,7 +64,7 @@ def search(
             elements (List[str]): A list of elements.
             exclude_elements (List(str)): List of elements to exclude.
             chemsys (str, List[str]): A chemical system, list of chemical systems
-                (e.g., Li-C-O, [C-O-H-N, Li-N]), or single formula (e.g., C2 H4).
+                (e.g., Li-C-O, [C-O-H-N, Li-N]).
             num_chunks (int): Maximum number of chunks of data to yield. None will yield all possible.
             chunk_size (int): Number of data entries per chunk.
             all_fields (bool): Whether to return all fields in the document. Defaults to True.