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

add docstrings (numPy style) to methods in utils #35

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

add docstrings (numPy style) to methods in utils #35

wants to merge 1 commit into from

Conversation

lena-kuhn
Copy link

Started equipping this great implementation of rake algorithm with docstrings according to the numpydoc guide. If you see fit, I can extend writing docstrings to algorithm.py and stopwords.py

Copy link
Owner

@vgrabovets vgrabovets left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great! Thank you for your work.
Could you, please, also fix really small issues with code style: https://travis-ci.org/vgrabovets/multi_rake/builds/573329575
Here is how to run checks locally: https://github.com/vgrabovets/multi_rake#development
If you want to continue, I would be really grateful. Just ping me when you're done and I will merge it and release to pypi.


Parameters
----------
text : utf8Bytes
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should be str, shouldn't it?



def separate_words(text):
"""Seperate text to tokens by whitespace and dimiss numeric tokens.
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typos: separate, dismiss

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants