Skip to content

Commit 0a57210

Browse files
committed
Update docstrings
1 parent 2d96000 commit 0a57210

File tree

6 files changed

+31
-22
lines changed

6 files changed

+31
-22
lines changed

pandas_datareader/moex.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,12 @@ class MoexReader(_DailyBaseReader):
1515
symbols : str, an array-like object (list, tuple, Series), or a DataFrame
1616
A single stock symbol (secid), an array-like object of symbols or
1717
a DataFrame with an index containing stock symbols.
18-
start : str, (defaults to '1/1/2010')
19-
The starting date, timestamp. Parses many different kind of date
20-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
21-
end : str, (defaults to today)
22-
The ending date, timestamp. Same format as starting date.
18+
start : string, int, date, datetime, timestamp
19+
Starting date. Parses many different kind of date
20+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
21+
20 years before current date.
22+
end : string, int, date, datetime, timestamp
23+
Ending date
2324
retry_count : int, default 3
2425
The number of times to retry query request.
2526
pause : int, default 0.1

pandas_datareader/quandl.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,12 @@ class QuandlReader(_DailyBaseReader):
2323
Beware of ambiguous symbols (different securities per country)!
2424
Note: Cannot use more than a single string because of the inflexible
2525
way the URL is composed of url and _get_params in the superclass
26-
start : string
27-
Starting date, timestamp. Parses many different kind of date
28-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
29-
end : string, (defaults to today)
30-
Ending date, timestamp. Same format as starting date.
26+
start : string, int, date, datetime, timestamp
27+
Starting date. Parses many different kind of date
28+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
29+
20 years before current date.
30+
end : string, int, date, datetime, timestamp
31+
Ending date
3132
retry_count : int, default 3
3233
Number of times to retry query request.
3334
pause : int, default 0.1

pandas_datareader/stooq.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,12 @@ class StooqDailyReader(_DailyBaseReader):
1212
symbols : string, array-like object (list, tuple, Series), or DataFrame
1313
Single stock symbol (ticker), array-like object of symbols or
1414
DataFrame with index containing stock symbols.
15-
start: string, date which to start interval at YYYYMMDD.
16-
end: string, date which to end interval at YYYYMMDD.
15+
start : string, int, date, datetime, timestamp
16+
Starting date. Parses many different kind of date
17+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
18+
20 years before current date.
19+
end : string, int, date, datetime, timestamp
20+
Ending date
1721
retry_count : int, default 3
1822
Number of times to retry query request.
1923
pause : int, default 0.1

pandas_datareader/tests/test_utils.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ class TestUtils(object):
1010
"input_date",
1111
[
1212
"2019-01-01",
13+
"JAN-01-2010",
1314
dt.datetime(2019, 1, 1),
1415
dt.date(2019, 1, 1),
1516
pd.Timestamp(2019, 1, 1),

pandas_datareader/tiingo.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -34,11 +34,12 @@ class TiingoIEXHistoricalReader(_BaseReader):
3434
----------
3535
symbols : {str, List[str]}
3636
String symbol of like of symbols
37-
start : str, (defaults to '1/1/2010')
38-
Starting date, timestamp. Parses many different kind of date
39-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
40-
end : str, (defaults to today)
41-
Ending date, timestamp. Same format as starting date.
37+
start : string, int, date, datetime, timestamp
38+
Starting date. Parses many different kind of date
39+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
40+
20 years before current date.
41+
end : string, int, date, datetime, timestamp
42+
Ending date
4243
retry_count : int, default 3
4344
Number of times to retry query request.
4445
pause : float, default 0.1

pandas_datareader/tsp.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,12 @@ class TSPReader(_BaseReader):
1212
symbols : str, array-like object (list, tuple, Series), or DataFrame
1313
Single stock symbol (ticker), array-like object of symbols or
1414
DataFrame with index containing stock symbols.
15-
start : str, (defaults to '1/1/2010')
16-
Starting date, timestamp. Parses many different kind of date
17-
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980')
18-
end : str, (defaults to today)
19-
Ending date, timestamp. Same format as starting date.
15+
start : string, int, date, datetime, timestamp
16+
Starting date. Parses many different kind of date
17+
representations (e.g., 'JAN-01-2010', '1/1/10', 'Jan, 1, 1980'). Defaults to
18+
20 years before current date.
19+
end : string, int, date, datetime, timestamp
20+
Ending date
2021
retry_count : int, default 3
2122
Number of times to retry query request.
2223
pause : int, default 0.1

0 commit comments

Comments
 (0)