Skip to content

Commit 1edeaf0

Browse files
authored
Merge pull request #1448 from ivan23kor/feature/clarify-end-argument
Clarify that interval is [start; end) in docstrings
2 parents 7b95f55 + 7f04a9d commit 1edeaf0

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

yfinance/base.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -556,11 +556,13 @@ def history(self, period="1mo", interval="1d",
556556
Valid intervals: 1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo
557557
Intraday data cannot extend last 60 days
558558
start: str
559-
Download start date string (YYYY-MM-DD) or _datetime.
559+
Download start date string (YYYY-MM-DD) or _datetime, inclusive.
560560
Default is 1900-01-01
561+
E.g. for start="2020-01-01", the first data point will be on "2020-01-01"
561562
end: str
562-
Download end date string (YYYY-MM-DD) or _datetime.
563+
Download end date string (YYYY-MM-DD) or _datetime, exclusive.
563564
Default is now
565+
E.g. for end="2023-01-01", the last data point will be on "2022-12-31"
564566
prepost : bool
565567
Include Pre and Post market data in results?
566568
Default is False

yfinance/multi.py

+4-2
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,13 @@ def download(tickers, start=None, end=None, actions=False, threads=True, ignore_
4444
Valid intervals: 1m,2m,5m,15m,30m,60m,90m,1h,1d,5d,1wk,1mo,3mo
4545
Intraday data cannot extend last 60 days
4646
start: str
47-
Download start date string (YYYY-MM-DD) or _datetime.
47+
Download start date string (YYYY-MM-DD) or _datetime, inclusive.
4848
Default is 1900-01-01
49+
E.g. for start="2020-01-01", the first data point will be on "2020-01-01"
4950
end: str
50-
Download end date string (YYYY-MM-DD) or _datetime.
51+
Download end date string (YYYY-MM-DD) or _datetime, exclusive.
5152
Default is now
53+
E.g. for end="2023-01-01", the last data point will be on "2022-12-31"
5254
group_by : str
5355
Group by 'ticker' or 'column' (default)
5456
prepost : bool

0 commit comments

Comments
 (0)