Skip to content

Commit d56d770

Browse files
committed
Remove useless module comments
1 parent 71e89b6 commit d56d770

13 files changed

Lines changed: 1 addition & 17 deletions

README.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,6 @@ summary_str = str(model_stats)
229229

230230
```python
231231
class LSTMNet(nn.Module):
232-
""" Batch-first LSTM model. """
233232
def __init__(self, vocab_size=20, embed_dim=300, hidden_dim=512, num_layers=2):
234233
super().__init__()
235234
self.hidden_dim = hidden_dim
@@ -382,7 +381,6 @@ summary(model, input_data=[input_data, other_input_data, ...])
382381

383382
```python
384383
class ContainerModule(nn.Module):
385-
""" Model using ModuleList. """
386384

387385
def __init__(self):
388386
super().__init__()
@@ -398,7 +396,6 @@ class ContainerModule(nn.Module):
398396

399397

400398
class ContainerChildModule(nn.Module):
401-
""" Model using Sequential in different ways. """
402399

403400
def __init__(self):
404401
super().__init__()

setup.cfg

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,7 @@ enable =
4444
deprecated-pragma,
4545
use-symbolic-message-instead,
4646
disable =
47+
missing-module-docstring,
4748
missing-function-docstring,
4849
too-many-instance-attributes,
4950
too-many-arguments,

setup.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" setup.py """
21
from setuptools import setup # type: ignore[import]
32

43
setup()

tests/conftest.py

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,5 @@
1-
""" conftest.py """
21
import sys
32
import warnings
4-
from difflib import Differ
53
from pathlib import Path
64
from typing import Iterator
75

@@ -59,8 +57,6 @@ def verify_output(capsys: pytest.CaptureFixture[str], filename: str) -> None:
5957
def verify_output_str(output: str, filename: str) -> None:
6058
with open(filename, encoding="utf-8") as output_file:
6159
expected = output_file.read()
62-
if output != expected:
63-
print("\n".join(Differ().compare(output.splitlines(), expected.splitlines())))
6460
assert output == expected
6561
for category in (ColumnSettings.NUM_PARAMS, ColumnSettings.MULT_ADDS):
6662
assert_sum_column_totals_match(output, category)

tests/exceptions_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" tests/torchinfo_test.py """
21
import pytest
32
import torch
43

tests/fixtures/models.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" fixtures/models.py """
21
# pylint: disable=too-few-public-methods
32
from __future__ import annotations
43

tests/torchinfo_test.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" tests/torchinfo_test.py """
21
import pytest
32
import torch
43
import torchvision # type: ignore[import]

torchinfo/__init__.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" torchinfo """
21
from .enums import ColumnSettings, RowSettings, Verbosity
32
from .model_statistics import ModelStatistics
43
from .torchinfo import summary

torchinfo/enums.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" constants.py """
21
from __future__ import annotations
32

43
from enum import Enum, IntEnum, unique

torchinfo/formatting.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
""" formatting.py """
21
from __future__ import annotations
32

43
import math

0 commit comments

Comments
 (0)