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

added documentation to the readme and _get_STATS function #27

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

vaughnrichard
Copy link

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.

@vaughnrichard
Copy link
Author

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.

@feamster
Copy link
Member

Thanks! Reviewing.

@jesteria jesteria requested review from jesteria and feamster October 24, 2023 22:38
@jesteria jesteria added the documentation Improvements or additions to documentation label Oct 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants