Skip to content

Commit

Permalink
update type hinting / docstr
Browse files Browse the repository at this point in the history
  • Loading branch information
esoteric-ephemera committed Nov 15, 2024
1 parent 73d245d commit d532d7f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions src/atomate2/common/jobs/electrode.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
from pymatgen.analysis.structure_matcher import StructureMatcher
from pymatgen.core import Structure
from pymatgen.entries.computed_entries import ComputedEntry
from pymatgen.io.common import VolumetricData


logger = logging.getLogger(__name__)
Expand Down Expand Up @@ -203,7 +204,7 @@ def get_insertion_electrode_doc(
@job
def get_inserted_structures(
prev_dir: Path | str,
get_charge_density: Callable,
get_charge_density: Callable[[str | Path], VolumetricData],
inserted_species: ElementLike,
insertions_per_step: int = 4,
charge_insertion_generator: ChargeInterstitialGenerator | None = None,
Expand All @@ -213,7 +214,7 @@ def get_inserted_structures(
Parameters
----------
prev_dir: The previous directory where the static calculation was performed.
get_charge_density: A function to get the charge density from a task document.
get_charge_density: A function to get the charge density from a run directory.
inserted_species: The species to insert.
insertions_per_step: The maximum number of ion insertion sites to attempt.
charge_insertion_generator: The charge insertion generator to use,
Expand Down

0 comments on commit d532d7f

Please sign in to comment.