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

Inconsistent Brackets #112

Open
pmbittner opened this issue Sep 25, 2024 · 0 comments
Open

Inconsistent Brackets #112

pmbittner opened this issue Sep 25, 2024 · 0 comments

Comments

@pmbittner
Copy link
Member

pmbittner commented Sep 25, 2024

As observed by @ekuiter and me as part of PR #109, some attributes sometimes have brackets for their entries and sometimes they don't (i.e., numpages = 10 vs. numpages = {10}). Affected attributes are at least numpages, volume, number, and year.

To fix this issue:

  1. Determine if there are other number-type attributes that might be affected.
  2. For each attribute decide on whether to keep or avoid brackets, such as numpages = 10 or numpages = {10}. Maybe avoid brackets for all of them, as we do for year? Can something else appear within these attributes that is not a number? At least for number I know that it might carry something else (e.g., number = {OOPSLA2} for BSM+:OOPSLA24). Here, not using brackets could falsely lead to OOPSLA2 being interpreted as a variable, in case such a variable is defined. This might lead to undesired, silent bugs for nun-numeric values. So maybe avoid brackets only for numeric values?
    • year: no brackets (this is mostly consistent throughout literature.bib)
    • numpages: ?
    • volume: ?
    • number: ?
  3. Enforce consistent style, best with an automated solution. @skrieter Do you think we could implement this as part of your CI pipeline? In best case, we
    • can find inconsistencies in the CI pipeline
    • have a script to automatically fix the styles for the whole literature.bib in a big-bang fix.

Maybe all of this is too overengineered anyway....

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants