Fix capitalizations in bibtex files #4209
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
What problem does this address?
BibTeX tries to "help" by applying consistent case to titles depending on the bibliography format being generated. Unfortunately it doesn't know about proper nouns, but fortunately it lets a human say "no really you should leave this capitalized".
What did you change?
Added {} around:
in all titles (only)
Switched to un-braced month abbreviations for all months, which BibTeX claims is the preferred format that styles will do the right thing with.
Documentation
Make sure to update relevant aspects of the documentation:
Update the release notes: reference the PR and related issues.Update relevant Data Source jinja templates (seedocs/data_sources/templates
).Update relevant table or source description metadata (seesrc/metadata
).Review and update any other aspects of the documentation that might be affected by this PR.Testing
How did you make sure this worked? How can a reviewer verify this?
To-do list
If updating analyses or data processing functions: make sure to update row count expectations indbt
tests.Runmake pytest-coverage
locally to ensure that the merge queue will accept your PR.For minor ETL changes or data additions, oncemake pytest-coverage
passes, make sure you have a fresh full PUDL DB downloaded locally, materialize new/changed assets and all their downstream assets and run relevant data validation tests usingpytest
and--live-dbs
.For bigger ETL or data changes run the full ETL locally and then run the data validations usingmake pytest-validate
.Alternatively, run thebuild-deploy-pudl
GitHub Action manually.