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 naming convention #524

Closed
3 tasks
NickleDave opened this issue Jun 22, 2022 · 0 comments · Fixed by #564
Closed
3 tasks

DOC: Better document naming convention #524

NickleDave opened this issue Jun 22, 2022 · 0 comments · Fixed by #564
Labels
DOC: documentation documentation
Projects

Comments

@NickleDave
Copy link
Collaborator

NickleDave commented Jun 22, 2022

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 annotate

Re-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)

The explanation would help, but you'd still need to look for it. Maybe make it more explicit in the tutorial? And/or refer to it in the error message?

edit: split into a separate issue (#525 ) that has to do with refactoring code

@NickleDave NickleDave added DOC: documentation documentation CLN: clean / refactor code cleanup, e.g. refactoring, maintenance, typos and removed CLN: clean / refactor code cleanup, e.g. refactoring, maintenance, typos labels Jun 22, 2022
@NickleDave NickleDave added this to To Do in BUG/MAINT Jun 29, 2022
@NickleDave NickleDave removed this from To Do in BUG/MAINT Jul 9, 2022
@NickleDave NickleDave added this to Backlog in DOC Jul 9, 2022
@NickleDave NickleDave moved this from Backlog to To do in DOC Aug 17, 2022
@NickleDave NickleDave moved this from To do to In progress in DOC Aug 17, 2022
@NickleDave NickleDave reopened this Aug 17, 2022
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
@NickleDave NickleDave moved this from In progress to Done in DOC Aug 18, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
DOC: documentation documentation
Projects
DOC
Done
Development

Successfully merging a pull request may close this issue.

1 participant