Skip to content

Commit 5a772a8

Browse files
Merge pull request #475 from DanielGoldfarb/master
Clarify show_nontrading behavior
2 parents 9ed0412 + 199d1a0 commit 5a772a8

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -264,7 +264,10 @@ Notice, in the above chart, there are no gaps along the x-coordinate, even thoug
264264

265265
- However, sometimes people like to see these gaps, so that they can tell, with a quick glance, where the weekends and holidays fall.
266266

267-
- Non-trading days can be displayed with the `show_nontrading` keyword.
267+
- Non-trading days can be displayed with the **`show_nontrading`** keyword.
268+
- Note that for these purposes **non-trading** intervals are those that ***are not represented in the data at all***. (There are simply no rows for those dates or datetimes). This is because, when data is retrieved from an exchange or other market data source, that data typically will *not* include rows for non-trading days (weekends and holidays for example). Thus ...
269+
- **`show_nontrading=True`** will display all dates (all time intervals) between the first time stamp and the last time stamp in the data (regardless of whether rows exist for those dates or datetimes).
270+
- **`show_nontrading=False`** (the default value) will show ***only*** dates (or datetimes) that have actual rows in the data. (This means that if there are rows in your DataFrame that exist but contain only **`NaN`** values, these rows *will still appear* on the plot even if **`show_nontrading=False`**)
268271
- For example, in the chart below, you can easily see weekends, as well as a gap at Thursday, November 28th for the U.S. Thanksgiving holiday.
269272

270273

File renamed without changes.

src/mplfinance/_version.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

2-
version_info = (0, 12, 8, 'beta', 1)
2+
version_info = (0, 12, 8, 'beta', 2)
33

44
_specifier_ = {'alpha': 'a','beta': 'b','candidate': 'rc','final': ''}
55

66
__version__ = '%s.%s.%s%s'%(version_info[0], version_info[1], version_info[2],
7-
'' if version_info[3]=='final' else _specifier_[version_info[3]]+str(version_info[4]))
7+
'' if version_info[3]=='final' else _specifier_[version_info[3]]+str(version_info[4]))

0 commit comments

Comments
 (0)