added documentation to the readme and _get_STATS function #27
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
|
Also - I added a comment on the parser file saying that the first element in the list returned could be an array where each of the 12 elements is a string denoting the feature found in its index. This would be useful if people could then set the columns to this array if they were making a pandas data frame with the returned list (I was doing that). Alternatively, there could perhaps be an option to directly return a data frame with these columns already set. |
|
Thanks! Reviewing. |
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.
When I was working on the homework I was a bit unclear on exactly what values I was going to be getting when using this function. I changed the readme/documentation a bit to try and make this more clear.