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

Feature documentation? #208

Open
Helveg opened this issue Mar 1, 2021 · 4 comments
Open

Feature documentation? #208

Helveg opened this issue Mar 1, 2021 · 4 comments

Comments

@Helveg
Copy link

Helveg commented Mar 1, 2021

It's been a while that the eFeature documentation here seems incomplete. Are there any plans of completing this guide? Currently I'm stuck trying to look through all of efel.getFeatureNames() to scout for interesting hits based on their name ;p Combine that with #27 lacking official docs or code snippets and it's not so clear how exactly to use efel from Python when the feature isn't readily available and explained in the first link.

@DrTaDa
Copy link
Contributor

DrTaDa commented Mar 2, 2021

Hello @Helveg,
for the eFeature descriptions, all of the features should be documented in the pdf linked at the top of the page https://efel.readthedocs.io/en/latest/eFeatures.html. Did you notice any missing ?
For code snippets, it is true that the examples in the present repository are lacking, we could add new ones.

@Helveg
Copy link
Author

Helveg commented Mar 2, 2021

Oh ok, there's an extra PDF? I'll look at that shortly but it would be nicer to have that in the sphinx doc ofcourse which is easier to search, navigate and index on search engines.

@wvangeit
Copy link
Contributor

wvangeit commented Mar 4, 2021

Yes, I know it's annoying to have a mix of documentation locations. As I mentioned in the other ticket, we're planning a big restructuring of the code. We will definitely make sure everything is correctly documented in one place there.
One of the reasons the pdf is still there is because there are quite some features that are never used. We also don't need to document all these never-used features.
If you let us know some important features you need, we can already now put them in the sphinx docs.

@Helveg
Copy link
Author

Helveg commented Mar 4, 2021

Well some of the features seem to only exist for the first five spikes, is there a general n-th or all spike variant for them? Also, is frequency available as a feature?

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

No branches or pull requests

3 participants