Skip to content

Commit 5d729e9

Browse files
Keep docstring coverage policy unchanged
1 parent 8a7659c commit 5d729e9

2 files changed

Lines changed: 13 additions & 13 deletions

File tree

physicsnemo/nn/functional/equivariant_ops.py

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,11 +22,15 @@
2222

2323

2424
@overload
25-
def smooth_log(x: Float[torch.Tensor, "..."]) -> Float[torch.Tensor, "..."]: ...
25+
def smooth_log(x: Float[torch.Tensor, "..."]) -> Float[torch.Tensor, "..."]:
26+
"""Apply smooth log elementwise to a tensor."""
27+
...
2628

2729

2830
@overload
29-
def smooth_log(x: TensorDict) -> TensorDict: ...
31+
def smooth_log(x: TensorDict) -> TensorDict:
32+
"""Apply smooth log elementwise to a TensorDict."""
33+
...
3034

3135

3236
def smooth_log(
@@ -59,11 +63,15 @@ def smooth_log(
5963
@overload
6064
def legendre_polynomials(
6165
x: Float[torch.Tensor, "..."], n: int
62-
) -> list[Float[torch.Tensor, "..."]]: ...
66+
) -> list[Float[torch.Tensor, "..."]]:
67+
"""Compute Legendre polynomials for a tensor input."""
68+
...
6369

6470

6571
@overload
66-
def legendre_polynomials(x: TensorDict, n: int) -> list[TensorDict]: ...
72+
def legendre_polynomials(x: TensorDict, n: int) -> list[TensorDict]:
73+
"""Compute Legendre polynomials for a TensorDict input."""
74+
...
6775

6876

6977
def legendre_polynomials(

test/ci_tests/check_docstring_coverage.py

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -148,15 +148,7 @@ def _read_baseline(baseline_path: Path) -> list[str]:
148148
def _run_interrogate(files: list[str], repo_root: Path) -> list[str]:
149149
"""Run interrogate on *files* and return the MISSED items."""
150150
result = subprocess.run( # noqa: S603 — command is hardcoded, not user input
151-
[
152-
sys.executable,
153-
"-m",
154-
"interrogate",
155-
"-vv",
156-
"--fail-under=0",
157-
"--no-color",
158-
"--ignore-overloaded-functions",
159-
]
151+
[sys.executable, "-m", "interrogate", "-vv", "--fail-under=0", "--no-color"]
160152
+ INTERROGATE_ARGS
161153
+ ["--"]
162154
+ files,

0 commit comments

Comments
 (0)