Skip to content

🚀 Candlestick Settings and Documentation - #7

Merged
serkor1 merged 11 commits into
develfrom
candlestick
Oct 30, 2025
Merged

🚀 Candlestick Settings and Documentation#7
serkor1 merged 11 commits into
develfrom
candlestick

Conversation

@serkor1

@serkor1 serkor1 commented Oct 29, 2025

Copy link
Copy Markdown
Owner

📚 What?

This PR implements candlestick settings and expands the documentation of candlestick pattern recognition functions.

* When initializing TA-Lib it would reset
  the candlestick settings. This has been removed as
  all settings are handled by reset_candle_setting()

* set_candle_setting() controls all candlestick setting
  and throws a warning if its not possible.
* The candles are now reset on unload and detach instead
  of load.
* Related to d0d0e30. The core idea
  is to set the settings via options() to avoid exporting more functions on
  the user-side. At the moment there are over 100 unique functions, and its starting
  to get cluttered.

  Until someone specifically finds a proper use-case for adding a specific function this
  is the way to go.
* The templates now supports the full documentation of the
  options and sets the options within each pattern call.

  NOTE: This is a rather crude implementation because each function is calling
        the setter everytime, even if it has not been changed. Its HIGHLY inefficient,
        but I am running out of ideas here. See the discussion here: cc1ca7e
* Documentation should really be handled via GHA, the committed number
  of files is getting out of hand really.

    SOON(TM)
* Honestly this change took me by surprise, I see not difference
  in the charts. So its anyones guess; I have nothing to add here.
@serkor1 serkor1 added the enhancement New feature or request label Oct 29, 2025
@codecov

codecov Bot commented Oct 29, 2025

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 96.77419% with 5 lines in your changes missing coverage. Please review.
✅ Project coverage is 92.29%. Comparing base (a56e233) to head (2778a36).
⚠️ Report is 11 commits behind head on devel.

Files with missing lines Patch % Lines
R/zzz.R 50.00% 3 Missing ⚠️
src/lib.c 85.71% 2 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##            devel       #7      +/-   ##
==========================================
+ Coverage   92.23%   92.29%   +0.06%     
==========================================
  Files         239      239              
  Lines       11156    11310     +154     
==========================================
+ Hits        10290    10439     +149     
- Misses        866      871       +5     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@serkor1
serkor1 marked this pull request as ready for review October 29, 2025 21:05
* The types were mismatched.
* The candles were reset *after* TA-Lib is shutdown, which should be
  logically impossible. There were no errors in the unit-tests, but just in case.
* The vignette is a draft, and demonstrates the basic usage and
  interpretation of the candlesticks and related options.
* The vignette is now more detailed, and contains
  more examples.
@serkor1 serkor1 changed the title 🚀 Candlestick Settings 🚀 Candlestick Settings and Documentation Oct 30, 2025
@serkor1
serkor1 merged commit 879d9ee into devel Oct 30, 2025
13 checks passed
@serkor1
serkor1 deleted the candlestick branch October 30, 2025 17:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant