Skip to content

Commit d532d7f

Browse files
update type hinting / docstr
1 parent 73d245d commit d532d7f

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

src/atomate2/common/jobs/electrode.py

+3-2
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
from pymatgen.analysis.structure_matcher import StructureMatcher
2222
from pymatgen.core import Structure
2323
from pymatgen.entries.computed_entries import ComputedEntry
24+
from pymatgen.io.common import VolumetricData
2425

2526

2627
logger = logging.getLogger(__name__)
@@ -203,7 +204,7 @@ def get_insertion_electrode_doc(
203204
@job
204205
def get_inserted_structures(
205206
prev_dir: Path | str,
206-
get_charge_density: Callable,
207+
get_charge_density: Callable[[str | Path], VolumetricData],
207208
inserted_species: ElementLike,
208209
insertions_per_step: int = 4,
209210
charge_insertion_generator: ChargeInterstitialGenerator | None = None,
@@ -213,7 +214,7 @@ def get_inserted_structures(
213214
Parameters
214215
----------
215216
prev_dir: The previous directory where the static calculation was performed.
216-
get_charge_density: A function to get the charge density from a task document.
217+
get_charge_density: A function to get the charge density from a run directory.
217218
inserted_species: The species to insert.
218219
insertions_per_step: The maximum number of ion insertion sites to attempt.
219220
charge_insertion_generator: The charge insertion generator to use,

0 commit comments

Comments
 (0)