Skip to content

Commit 2199a03

Browse files
update docstring
1 parent f6a7eea commit 2199a03

File tree

2 files changed

+7
-11
lines changed

2 files changed

+7
-11
lines changed

src/mplfinance/_candelstick_new_docstring.py

Lines changed: 0 additions & 7 deletions
This file was deleted.

src/mplfinance/_utils.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -489,13 +489,16 @@ def _construct_candlestick_collections(dates, opens, highs, lows, closes, market
489489

490490

491491
def _construct_hollow_candlestick_collections(dates, opens, highs, lows, closes, marketcolors=None, config=None):
492-
"""Represent the open, close as a bar line and high low range as a
493-
vertical line. Same as basic candlestick, but utilizes solid and hollow candlesticks
492+
"""Represent today's open to close as a "bar" line (candle body)
493+
and high low range as a vertical line (candle wick)
494+
495+
If config['type']=='hollow_and_filled' (hollow and filled candles) then candle edge and
496+
wick color depend on PREVIOUS close to today's close (up or down), and the center of the
497+
candle body (hollow or filled) depends on the today's open to close (up or down).
494498
495499
NOTE: this code assumes if any value open, low, high, close is
496500
missing they all are missing
497501
498-
499502
Parameters
500503
----------
501504
opens : sequence
@@ -508,7 +511,7 @@ def _construct_hollow_candlestick_collections(dates, opens, highs, lows, closes,
508511
sequence of closing values
509512
marketcolors : dict of colors: up, down, edge, wick, alpha
510513
alpha : float
511-
bar transparency
514+
bar (candle body) transparency
512515
513516
Returns
514517
-------

0 commit comments

Comments
 (0)