Skip to content

Allow creating the documentation-only classes #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Luthaf merged 1 commit into from
May 20, 2026
Merged

Allow creating the documentation-only classes #230

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions python/metatomic_torch/metatomic/torch/documentation.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -209,7 +209,7 @@ def __init__(
:param requestor: who requested this neighbors list, you can add additional
requestors later using :py:meth:`add_requestor`
"""
raise THIS_CODE_SHOULD_NOT_RUN
pass

@property
def cutoff(self) -> float:
Expand Down Expand Up @@ -287,7 +287,7 @@ def __init__(
explicit_gradients: List[str] = [], # noqa B006
description: str = "",
):
raise THIS_CODE_SHOULD_NOT_RUN
pass

@property
def quantity(self) -> str:
Expand Down Expand Up @@ -360,7 +360,7 @@ def __init__(
supported_devices: List[str] = [], # noqa B006
dtype: str = "",
):
raise THIS_CODE_SHOULD_NOT_RUN
pass

@property
def outputs(self) -> Dict[str, ModelOutput]:
Expand Down Expand Up @@ -445,7 +445,7 @@ def __init__(
outputs: Dict[str, ModelOutput] = {}, # noqa B006
selected_atoms: Optional[Labels] = None,
):
raise THIS_CODE_SHOULD_NOT_RUN
pass

@property
def length_unit(self) -> str:
Expand Down Expand Up @@ -488,7 +488,7 @@ def __init__(
references: Dict[str, List[str]] = {}, # noqa: B006
extra: Dict[str, str] = {}, # noqa: B006
):
raise THIS_CODE_SHOULD_NOT_RUN
pass

name: str
"""Name of this model"""
Expand Down
Loading