Skip to content

Commit

Permalink
upd docstrings
Browse files Browse the repository at this point in the history
  • Loading branch information
voorhs committed Jan 16, 2025
1 parent 4a81fa9 commit 2ebfa4e
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions autointent/configs/_optimization.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,15 +69,15 @@ def define_dump_dir(self) -> None:

@property
def safe_run_name(self) -> str:
# This property ensures that the type checker knows `run_name` is a `str`
"""Use this method for type safety instead of :py:attr:`LoggingConfig.run_name`."""
if self.run_name is None:
msg = "run_name should not be None after validation"
raise ValueError(msg)
return self.run_name

@property
def safe_dirpath(self) -> Path:
# This property ensures that the type checker knows `run_name` is a `str`
"""Use this method for type safety instead of :py:attr:`LoggingConfig.dirpath`."""
if self.dirpath is None:
msg = "dirpath should not be None after validation"
raise ValueError(msg)
Expand Down

0 comments on commit 2ebfa4e

Please sign in to comment.