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

commands.doctor: rename keys-exist to keys-missing #854

Merged
merged 2 commits into from
May 23, 2024

Conversation

alexfikl
Copy link
Collaborator

This renames the keys-exist check to keys-missing with a bunch of deprecation warnings.

@jghauser What do you think about this? Should we also change the default to biblatex-required-keys for smarter missing key reporting?

Fixes #849.

@jghauser
Copy link
Member

Yes, keys-missing is much better. And yeah, I think biblatex-required-keys might be a better default, the keys-exist test generates a lot of false positives.

@alexfikl
Copy link
Collaborator Author

Yes, keys-missing is much better. And yeah, I think biblatex-required-keys might be a better default, the keys-exist test generates a lot of false positives.

@jghauser I went ahead and changed the defaults from files, keys-missing, duplicated-keys to files, biblatex-required-keys, bibtex-type, refs. What do you think? The motivation was mostly to make sure the metadata is BibTeX friendly since we're pretty BibTeX oriented. These should also not have many (any?) false positives.

@jghauser
Copy link
Member

Yeah, I think that makes a lot of sense. You're right that being compatible with BibTeX is probably important to most users, so I think those defaults are sensible!

@alexfikl
Copy link
Collaborator Author

Thanks for looking over this! In it goes 🚀

@alexfikl alexfikl merged commit 998db16 into papis:main May 23, 2024
19 checks passed
@alexfikl alexfikl deleted the doctor-key-missing branch May 23, 2024 08:34
@jghauser
Copy link
Member

Just ran this and I'm getting bibtex-type errors twice:

bibtex-type	type	/home/julian/Documents/library/main/snowden-2019-permanent-record
bibtex-type	type	/home/julian/Documents/library/main/snowden-2019-permanent-record

This document doesn't have a type at all. Not sure if this is because of this PR or something that happened before as well.

@alexfikl
Copy link
Collaborator Author

Just ran this and I'm getting bibtex-type errors twice:
This document doesn't have a type at all. Not sure if this is because of this PR or something that happened before as well.

#862 should fix that. Since both bibtex-type and biblatex-required-keys need to know the BibTeX type, they both throw an error when they can't find it. Now at least they're marked separately..

@jghauser
Copy link
Member

Oh my bad, I thought that was already merged!

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

Successfully merging this pull request may close these issues.

papis doctor: various quirks
2 participants