Skip to content

add functions documents#75

Open
nehemiah888 wants to merge 2 commits into
TA-Lib:mainfrom
nehemiah888:main
Open

add functions documents#75
nehemiah888 wants to merge 2 commits into
TA-Lib:mainfrom
nehemiah888:main

Conversation

@nehemiah888

Copy link
Copy Markdown

Add functions/ directory in docs/ directory, and the functions are grouped. every function has calculation/formula, interpreter, example sections. And every function has a chinese version too.
I tried to find such documents but failed, so I generated these documents by AI, and let differnet AI model to have a double check on the calculation/formula part to align to the codes.
I wish these documents could be merged to original project, so anybody could review/contribute these documents, and then make these documents better and better.

@mario4tier

Copy link
Copy Markdown
Member

@nehemiah888

Documentation had to be handled differently because TA-Lib is intended to be distributed in various way, the website being only one of them.

So I am trying to develop a "Single source of truth" from which various format can be generated (in particular Rust/NPM).

The solution so far is to have a doc markdown alongside the "code" in ta_codegen/input.

Example for sma, the input file is:
https://github.com/TA-Lib/ta-lib/blob/main/ta_codegen/input/sma/sma.md

... this file is used by ta_codegen to maintain the website. The output is:
https://ta-lib.org/functions/sma/

So effort now should be directed to maintain the markdown files under ta_codegen/input.

I am sorry that I went a different way than your approach. Your idea and initiative was good.

If interested, there is still iterative work to be done on the input file. In particular, the formula section generally "look bad" and we have to find an AI friendly way to express these (Latex?)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants