Skip to content

Commit

Permalink
Rewrite the exc module docs
Browse files Browse the repository at this point in the history
Revise the module docs and rewrite the docs for the `ConflictError` and `NotFoundError`
classes.

Refs #10
  • Loading branch information
Aesonus committed Oct 17, 2024
1 parent b7214ce commit cd6afe2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions alchemical_storage/storage/exc.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
"""Exceptions for alchemical_storage."""
"""Exceptions for the ``alchemical_storage.storage`` package."""


class ConflictError(Exception):
"""Conflict error."""
"""Raised when putting a value that already exists in the storage."""


class NotFoundError(Exception):
"""Not found error."""
"""Raised when getting a value that does not exist in the storage."""

0 comments on commit cd6afe2

Please sign in to comment.