Overview

What problem does this address?

In FERC Form 1 Data extractor i.e. file src\pudl\extract\ferc1.py, the most recent development version of SQLite compilation database of the original FERC Form 1 databases had a deadlink.
URLs were mentioned inconsistently as per ReadTheDocs conventions.

What did you change?

Testing

How did you make sure this worked? How can a reviewer verify this?

URLs are active now.
Python docstrings themselves do not have clickable links embedded within them by default. However, these docstrings are populated over the ReadTheDocs(Sphinx) hence documentation have better URL consistency now along with package names for better readability.

[x] If updating analyses or data processing functions: make sure to update or write data validation tests (e.g., test_minmax_rows())
[x] Update the release notes: reference the PR and related issues.
[x] Ensure docs build, unit & integration tests, and test coverage pass locally with make pytest-coverage (otherwise the merge queue may reject your PR)
[x] Review the PR yourself and call out any questions or issues you have
[x] For minor ETL changes or data additions, once make 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 using pytest and --live-dbs.
[x] For significant ETL, data coverage or analysis changes, once make pytest-coverage passes, ensure the full ETL runs locally and run data validation tests using make pytest-validate (a ~10 hour run). If you can't run this locally, run the build-deploy-pudl GitHub Action (or ask someone with permissions to). Then, check the logs on the #pudl-deployments Slack channel or gs://builds.catalyst.coop.

Apr 14 '24 12:04 hrishikeshh

Thanks @jdangerx , I will update.

Apr 15 '24 21:04 hrishikeshh

Closing this, and picking this contribution up in https://github.com/catalyst-cooperative/pudl/pull/3672. Thanks so much for your contribution!

Jun 14 '24 20:06 e-belfer