Fix markdown violations on Readme #22
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Hey @areed1192, congratulations on making the first PR to eiapy that isn't from me! 😆 What did you have in mind for refactoring? |
|
Oh trust me I've been there 😆! For the most part when it comes to refactoring I was thinking of splitting up the main client file into a folder called Let me know what you think. |
systemcatch
reviewed
Apr 14, 2021
There was a problem hiding this comment.
Hey @areed1192 a few comments from me but looks good otherwise.
| ``` | ||
|
|
||
| Further examples can be found [in this gist](https://gist.github.com/systemcatch/019cf50302093b9b51838c62b99623df). | ||
|
|
||
| To find more details about the API go to the EIA's [Open Data](https://www.eia.gov/opendata/) page. To find interesting data (and identifiers) [browse the data sets](https://www.eia.gov/opendata/qb.php). | ||
| To find more details about the API go to the EIA"s |
There was a problem hiding this comment.
Hey @areed1192 can you confirm either way on this? Once it's done I'll merge.
| An API key is needed to access the EIA's data, you can get one [here](https://www.eia.gov/opendata/register.php). eiapy needs this key to be manually set in the operating system environmental variables. | ||
| ## Setting up your API key | ||
|
|
||
| An API key is needed to access the EIA"s data, you can get one [here](https://www.eia.gov/opendata/register.php). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Went through and cleaned up the
README.mdfile. I was planning on doing some refactoring of the code if you're open to it.