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

DOC: Better document spectrogram options, e.g. with a how-to + link to API + reference docs #686

Open
NickleDave opened this issue Jul 23, 2023 · 0 comments
Assignees
Labels
DOC: documentation documentation

Comments

@NickleDave
Copy link
Collaborator

Unclear from the docs right now how spectrogram can be configured, see this question in the vocalpy forum:
https://forum.vocalpy.org/t/specifying-the-frequency-range-using-vak/67/2

We do document the section of the config file using the class that represents it but there's zero narrative text around it: https://vak.readthedocs.io/en/latest/reference/config.html#spect-params-section

One could also find this function's docstring in the API doc if they looked hard enough but there's not much there either: https://vak.readthedocs.io/en/latest/api/generated/vak.spect.spectrogram.html#vak.spect.spectrogram

We should instead add to the how-to guide here:
https://vak.readthedocs.io/en/latest/howto/index.html

@NickleDave NickleDave added the DOC: documentation documentation label Jul 23, 2023
@NickleDave NickleDave self-assigned this Jul 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC: documentation documentation
Projects
None yet
Development

No branches or pull requests

1 participant