Skip to content

Commit

Permalink
docs: remove module comments (#171)
Browse files Browse the repository at this point in the history
The comments are redundant and most of them misleading as they referred
to modules as packages.
  • Loading branch information
mbelak-dtml authored Oct 9, 2023
1 parent 2d3371f commit d6d24b0
Show file tree
Hide file tree
Showing 21 changed files with 1 addition and 40 deletions.
2 changes: 0 additions & 2 deletions edvart/data_types.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Module defines data types and helper function for recognizing them."""

from enum import IntEnum

import numpy as np
Expand Down
1 change: 0 additions & 1 deletion edvart/example_datasets.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
"""Module for loading example datasets."""
import os

import pandas as pd
Expand Down
2 changes: 0 additions & 2 deletions edvart/pandas_formatting.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Pandas formatting package."""

from typing import Any, Dict, List, Union

import pandas as pd
Expand Down
2 changes: 0 additions & 2 deletions edvart/plots.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Plots package."""

from typing import Optional, Tuple, Union

import matplotlib.pyplot as plt
Expand Down
2 changes: 0 additions & 2 deletions edvart/report.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Report package."""

import base64
import logging
import pickle
Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/bivariate_analysis.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Bivariate analysis section package."""

import itertools
from enum import IntEnum
from typing import Any, Callable, Dict, List, Optional, Tuple, Union
Expand Down
1 change: 0 additions & 1 deletion edvart/report_sections/code_string_formatting.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
# Standard imorts
from inspect import getsource
from itertools import dropwhile
from textwrap import dedent
Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/group_analysis.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Group analysis module."""

from typing import Any, Callable, Dict, List, Optional, Union

import colorlover as cl
Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/multivariate_analysis.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Multivariate analysis package."""

from enum import IntEnum
from typing import Any, Dict, List, Optional, Tuple

Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/timeseries_analysis/__init__.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Time series analysis package."""

from .autocorrelation import Autocorrelation
from .boxplots_over_time import BoxplotsOverTime
from .fourier_transform import FourierTransform
Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/timeseries_analysis/autocorrelation.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Autocorrelation plot package."""

import functools
from typing import Any, Dict, List, Optional, Tuple

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Boxplots over time package."""

from datetime import datetime
from itertools import takewhile
from typing import Any, Callable, Dict, List, Optional, Tuple
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Fourier transform package."""

from typing import Any, Dict, List, Optional, Tuple

import matplotlib.pyplot as plt
Expand All @@ -8,7 +6,7 @@
import pandas as pd
from IPython.display import Markdown, display

from edvart.data_types import is_numeric # noqa:I100
from edvart.data_types import is_numeric
from edvart.decorators import check_index_time_ascending
from edvart.report_sections.code_string_formatting import get_code
from edvart.report_sections.section_base import Section, Verbosity
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Rolling statistics package."""

import warnings
from typing import Any, Dict, List, Optional

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Seasonal decomposition package."""

from typing import Any, Dict, List, Optional, Tuple

import matplotlib.pyplot as plt
Expand Down
2 changes: 0 additions & 2 deletions edvart/report_sections/timeseries_analysis/short_time_ft.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Short-time Fourier transform package."""

from typing import Any, Dict, List, Optional, Tuple, Union

import matplotlib.pyplot as plt
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Stationarity tests package."""

import warnings
from functools import partial
from typing import Any, Callable, Dict, List, Optional
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Time series line plot package."""

from typing import Any, Dict, List, Optional

import nbformat.v4 as nbfv4
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Time series analysis package."""

from enum import IntEnum
from typing import Any, Dict, List, Optional

Expand Down
1 change: 0 additions & 1 deletion edvart/report_sections/univariate_analysis.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
"""Univariate analysis package."""
from typing import Any, Callable, Dict, List, Optional, Tuple

import matplotlib.pyplot as plt
Expand Down
2 changes: 0 additions & 2 deletions edvart/utils.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
"""Utils package."""

import os
from contextlib import contextmanager
from typing import Any, Dict, Iterable, Iterator, List, Literal, Optional, Tuple, Union
Expand Down

0 comments on commit d6d24b0

Please sign in to comment.