Skip to content

Commit b51f399

Browse files
committed
update the docstring of encoders
1 parent 9b0354f commit b51f399

File tree

3 files changed

+403
-233
lines changed

3 files changed

+403
-233
lines changed

docs/source/conf.py

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -94,13 +94,16 @@ def get_by_name(string: str):
9494
"""
9595
Import by name and return imported module/function/class
9696
97-
Args:
98-
string (str): module/function/class to import, e.g. 'pandas.read_csv' will return read_csv function as
99-
defined by pandas
100-
101-
Returns:
97+
Parameters
98+
----------
99+
string (str):
100+
module/function/class to import, e.g. 'pandas.read_csv'
101+
will return read_csv function as defined by pandas
102+
103+
Returns
104+
-------
102105
imported object
103-
""" # noqa: E501
106+
"""
104107
class_name = string.split(".")[-1]
105108
module_name = ".".join(string.split(".")[:-1])
106109

pytorch_forecasting/data/__init__.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
"""
22
Datasets, etc. for timeseries data.
33
4-
Handling timeseries data is not trivial. It requires special treatment. This sub-package provides the necessary tools
5-
to abstracts the necessary work.
6-
""" # noqa: E501
4+
Handling timeseries data is not trivial. It requires special treatment.
5+
This sub-package provides the necessary tools to abstracts the necessary work.
6+
"""
77

88
from pytorch_forecasting.data.encoders import (
99
EncoderNormalizer,

0 commit comments

Comments
 (0)