From 4a42aad9b85926829e8c7b1ab5a578f02c6a1f1f Mon Sep 17 00:00:00 2001 From: alin m elena Date: Mon, 4 Mar 2024 12:09:52 +0000 Subject: [PATCH] one --- docs/source/conf.py | 5 +---- janus_core/janus_types.py | 15 ++++++++------- 2 files changed, 9 insertions(+), 11 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 44c72cdd..8e141027 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -183,10 +183,7 @@ # Warnings to ignore when using the -n (nitpicky) option # We should ignore any python built-in exception, for instance -nitpick_ignore = [ - ("py:class", "Logger"), - ("py:class", "numpy.float64") -] +nitpick_ignore = [("py:class", "Logger"), ("py:class", "numpy.float64")] def run_apidoc(_): diff --git a/janus_core/janus_types.py b/janus_core/janus_types.py index d99022eb..c167bb98 100644 --- a/janus_core/janus_types.py +++ b/janus_core/janus_types.py @@ -1,9 +1,10 @@ """ -Module containing types used in Janus-Core +Module containing types used in Janus-Core. """ +from collections.abc import Sequence from pathlib import Path, PurePath -from typing import IO, Literal, Optional, Sequence, TypedDict, TypeVar, Union +from typing import IO, Literal, Optional, TypedDict, TypeVar, Union from ase import Atoms import numpy as np @@ -21,7 +22,7 @@ class ASEReadArgs(TypedDict, total=False): - """Main arguments for ase.io.read""" + """Main arguments for ase.io.read.""" filename: Union[str, PurePath, IO] index: Union[int, slice, str] @@ -31,7 +32,7 @@ class ASEReadArgs(TypedDict, total=False): class ASEWriteArgs(TypedDict, total=False): - """Main arguments for ase.io.write""" + """Main arguments for ase.io.write.""" filename: Union[str, PurePath, IO] images: MaybeSequence[Atoms] @@ -41,7 +42,7 @@ class ASEWriteArgs(TypedDict, total=False): class ASEOptArgs(TypedDict, total=False): - """Main arugments for ase optimisers""" + """Main arugments for ase optimisers.""" restart: Optional[bool] logfile: Optional[PathLike] @@ -49,7 +50,7 @@ class ASEOptArgs(TypedDict, total=False): class ASEOptRunArgs(TypedDict, total=False): - """Main arugments for running ase optimisers""" + """Main arugments for running ase optimisers.""" fmax: float steps: int @@ -61,7 +62,7 @@ class ASEOptRunArgs(TypedDict, total=False): class CalcResults(TypedDict, total=False): - """Return type from calculations""" + """Return type from calculations.""" energy: MaybeList[float] forces: MaybeList[NDArray[np.float64]]