edited data dictionary description

[Nancy9ice]

Overview

Closes this Google Season of Docs Task:
There should be a description of what the Data dictionaries sub-page is about before the list

What problem does this address?
This adds descriptions for the Data dictionary sub-headings in the readthedocs to aid clarity for users.

Testing

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

I ran the command sphinx-build -b html docs docs/_build/html and checked if my changes reflected correctly locally

@aesharpe @zaneselvans

[zaneselvans]

For testing the documentation output, I think it will usually be preferable to run:

make docs-build

Which rebuilds the documentation from scratch, after removing all dynamically generated outputs, which can occasionally be leftover after a failed docs build.

While running the Sphinx command directly can be faster if there's a single file you're editing and you want to see the results of your edits. The CI on GitHub will attempt to rebuild that docs from scratch with the make command though.

[Nancy9ice]

Okay, noted. I'll apply this to the other pull requests I'll work on later

[e-belfer]

Looks good! I just have a few minor wording suggestions.

[e-belfer]

Looks great, thanks!

Missed the docs failure!

[e-belfer]

@Nancy9ice Looks like there are two "line too long" errors in lines 8 and 20 of index.rst. Once they're split, should be good to go!

docs/data_dictionaries/index.rst:8: D001 Line too long
docs/data_dictionaries/index.rst:20: D001 Line too long

[Nancy9ice]

@Nancy9ice Looks like there are two "line too long" errors in lines 8 and 20 of index.rst. Once they're split, should be good to go!

docs/data_dictionaries/index.rst:8: D001 Line too long
docs/data_dictionaries/index.rst:20: D001 Line too long

Resolved!

[zaneselvans]

Hmm, docs build still seems to be failing. Did you push?

[aesharpe]

Maybe out of scope for this PR, but @Nancy9ice I also think it would be a good idea to change the name of this data dictionary to "Raw FERC Form 1 Data Dictionary" vs. "FERC For 1 Data Dictionary" if it's not too hard.

[Nancy9ice]

Hmm, docs build still seems to be failing. Did you push?

Sorry, I just noticed I didn't push. I've pushed it now. Please confirm that the make docs-build test now runs successfully

[Nancy9ice]

Maybe out of scope for this PR, but @Nancy9ice I also think it would be a good idea to change the name of this data dictionary to "Raw FERC Form 1 Data Dictionary" vs. "FERC For 1 Data Dictionary" if it's not too hard.

I just added this and pushed it. Thanks

[aesharpe]

This looks great! Thanks @Nancy9ice