-
Notifications
You must be signed in to change notification settings - Fork 17
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 naming convention #524
Labels
DOC: documentation
documentation
Comments
3 tasks
Closed
4 tasks
NickleDave
added a commit
that referenced
this issue
Aug 17, 2022
that explicitly documents naming conventions, so that we can reference this elsewhere, as described in #524.
NickleDave
added a commit
that referenced
this issue
Aug 17, 2022
Adds a page on file naming conventions to the reference section of the docs, that we can link to from other pages (as in #524) and from error messages (see #525). Also adds a page with Frequently Asked Questions, with information on how to annotate data for use with `vak` and links to other how-tos. Fixes #424. Squashed commits: - Add target to howto_user_annot.md Add target to header "spectrogram file naming conventions" so we can reference it from a separate page on file naming conventions. - Add doc/reference/filenames.md that explicitly documents naming conventions, so that we can reference this elsewhere, as described in #524. - Add doc/faq.md, fixes #424 - Add "getting help" to doc/index.md with link to just-added FAQ, as well as links to forum and issue tracker. - Update 'support/contributing' section of README to match the "Getting Help" section on the index of the docs, with links to FAQ, forum, issue tracker, and additionally the contributing docs. - Add faq to toctree in doc/index.md - Add link to naming conventions in howto_user_annot callout
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Seems like we still need to do a better job of documenting the naming convention that
vak
expects when it matches annotation files with the files they annotateRe-reading this "naming convention" callout on the how-to page, it does seem like it could be clearer.
https://vak.readthedocs.io/en/latest/howto/howto_user_annot.html#method-1-converting-your-annotations-to-the-simple-seq-format
And it might help to add some reasoning for the convention?
#523 (comment)
But we could do more.
As suggested by @sthaar:
#523 (comment)
edit: split into a separate issue (#525 ) that has to do with refactoring code
recursive_stem
and add clearer error message #525The text was updated successfully, but these errors were encountered: