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

Add release notes explaning FERC 1 metadata cleanup #2626

Merged
merged 9 commits into from
Jun 12, 2023

Conversation

zaneselvans
Copy link
Member

PR Overview

@cmgosnell & @e-belfer I noticed that we haven't really been documenting our cleanup of the FERC 1 metadata / calculations in the release notes, which seems like it'll be helpful. I added a note about adding the correction records, if y'all want to add your own notes about what you've done and the issues / PRs that would be great!

PR Checklist

  • Merge the most recent version of the branch you are merging into (probably dev).
  • All CI checks are passing. Run tests locally to debug failures
  • Make sure you've included good docstrings.
  • For major data coverage & analysis changes, run data validation tests
  • Include unit tests for new functions and classes.
  • Defensive data quality/sanity checks in analyses & data processing functions.
  • Update the release notes and reference reference the PR and related issues.
  • Do your own explanatory review of the PR to help the reviewer understand what's going on and identify issues preemptively.

@zaneselvans zaneselvans added data-repair Interpolating or extrapolating data that we don't actually have. docs Documentation for users and contributors. metadata Anything having to do with the content, formatting, or storage of metadata. Mostly datapackages. xbrl Related to the FERC XBRL transition labels Jun 2, 2023
@zaneselvans zaneselvans added this to the 2023 Spring milestone Jun 2, 2023
@codecov
Copy link

codecov bot commented Jun 2, 2023

Codecov Report

Patch coverage: 94.3% and project coverage change: +0.2 🎉

Comparison is base (fe395c9) 86.9% compared to head (a335fe8) 87.2%.

❗ Current head a335fe8 differs from pull request most recent head 4c7e69b. Consider uploading reports for the commit 4c7e69b to get more accurate results

Additional details and impacted files
@@           Coverage Diff           @@
##             dev   #2626     +/-   ##
=======================================
+ Coverage   86.9%   87.2%   +0.2%     
=======================================
  Files         84      86      +2     
  Lines       9720   10001    +281     
=======================================
+ Hits        8447    8721    +274     
- Misses      1273    1280      +7     
Impacted Files Coverage Δ
src/pudl/metadata/fields.py 100.0% <ø> (ø)
src/pudl/metadata/resources/ferc1.py 100.0% <ø> (ø)
src/pudl/metadata/sources.py 100.0% <ø> (ø)
src/pudl/transform/params/ferc1.py 100.0% <ø> (ø)
src/pudl/extract/xbrl.py 94.2% <33.3%> (-2.8%) ⬇️
src/pudl/ferc_to_sqlite/cli.py 70.7% <71.4%> (-0.7%) ⬇️
src/pudl/workspace/datastore.py 75.6% <71.4%> (+2.5%) ⬆️
src/pudl/extract/dbf.py 88.8% <87.8%> (-0.2%) ⬇️
src/pudl/extract/ferc.py 91.6% <91.6%> (ø)
src/pudl/transform/ferc1.py 96.6% <98.6%> (+0.4%) ⬆️
... and 4 more

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/release_notes.rst Outdated Show resolved Hide resolved
Base automatically changed from xbrl_meta_reshape to dev June 8, 2023 17:19
@zaneselvans zaneselvans merged commit c00edc5 into dev Jun 12, 2023
6 checks passed
@zaneselvans zaneselvans deleted the xbrl-meta-release-notes branch June 12, 2023 16:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-repair Interpolating or extrapolating data that we don't actually have. docs Documentation for users and contributors. metadata Anything having to do with the content, formatting, or storage of metadata. Mostly datapackages. xbrl Related to the FERC XBRL transition
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

None yet

2 participants