Skip to content

Commit b01ded5

Browse files
committed
update docstring
1 parent 5f4f57b commit b01ded5

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

src/atomate2/forcefields/schemas.py

+4-3
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ def from_ase_compatible_result_forcefield(
169169
tags: list[str] | None = None,
170170
**task_document_kwargs,
171171
) -> ForceFieldStructureTaskDocument | ForceFieldMoleculeTaskDocument:
172-
"""Create an AseTaskDoc for a task that has ASE-compatible outputs.
172+
"""Create an ForceField output for a task that has ASE-compatible outputs.
173173
174174
Parameters
175175
----------
@@ -240,14 +240,15 @@ def from_ase_compatible_result_forcefield(
240240
def from_ase_task_doc(
241241
cls, ase_task_doc: AseTaskDoc, **task_document_kwargs
242242
) -> ForceFieldStructureTaskDocument | ForceFieldMoleculeTaskDocument:
243-
"""Create an AseStructureTaskDoc for a task that has ASE-compatible outputs.
243+
"""Create an ForceField output for a task that has ASE-compatible outputs.
244244
245245
Parameters
246246
----------
247247
ase_task_doc : AseTaskDoc
248248
Task doc for the calculation
249249
task_document_kwargs : dict
250-
Additional keyword args passed to :obj:`.AseStructureTaskDoc()`.
250+
Additional keyword args passed to :obj:`.ForceFieldStructureTaskDocument()`
251+
or `.ForceFieldMoleculeTaskDocument()`.
251252
"""
252253
task_document_kwargs.update(
253254
{k: getattr(ase_task_doc, k) for k in _task_doc_translation_keys},

0 commit comments

Comments
 (0)