Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

KVO docs typo #227

Closed
DaveSkender opened this issue May 7, 2022 · 4 comments
Closed

KVO docs typo #227

DaveSkender opened this issue May 7, 2022 · 4 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@DaveSkender
Copy link
Member

DaveSkender commented May 7, 2022

Documented KVO method should be fixed and not reflect Keltner. Typo. We'll need to also review the parameters and for other missing items while we taking a look.

is there a reason why the function for the KVO is called get_keltner() and not e.g. get_klinger()? See here: https://python.stockindicators.dev/indicators/Kvo/#content

Thanks,
Andy

Originally posted by @August1328 in DaveSkender/Stock.Indicators#446 (comment)

@DaveSkender DaveSkender added good first issue Good for newcomers documentation Improvements or additions to documentation labels May 7, 2022
@LeeDongGeon1996
Copy link
Member

@August1328 Please let us know, if you'd like to contribute on this. We can wait for it, if you need time to learn GitHub.

@DaveSkender
Copy link
Member Author

Might be good to also add a note in the Guide about dataframe conversion. That seems to be a common thing. @LeeDongGeon1996 is dataframe something we want to accept as an alternative input form?

@LeeDongGeon1996
Copy link
Member

LeeDongGeon1996 commented May 9, 2022

Right. In most of use-cases in Python, people use Pandas dataframe, so It would be good to add in Guide.
Actually, I'm worrying about performance to convert them, so thinking about C-extension for Python to convert them faster.

While Python is a great language and a pleasure to code in, its dynamic nature results in overhead that can cause some code ( i.e. raw computations inside of for loops) to be up 10-100 times slower than equivalent code written in a static compiled language.
From Numpy docs: https://numpy.org/doc/stable/user/c-info.python-as-glue.html#calling-other-compiled-libraries-from-python)

dataframe consists of 1D-array of Numpy internally.

Do you think it is the case of above? or is it too much? (like a dtype feature we've discussed about before)

@DaveSkender
Copy link
Member Author

I think we can just start with some guidance in docs. I suspect Python users simply know and accept that it’s slower in some aspects than compiled code. Exploring a C or C# extension is also a good idea.

LeeDongGeon1996 added a commit to LeeDongGeon1996/Stock.Indicators.Python that referenced this issue May 28, 2022
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Sep 8, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants