Skip to content

Commit

Permalink
issues link updated. formatting updated for readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
mwtmurphy committed Sep 1, 2017
1 parent bc945ce commit 1207ea5
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@
Summary
-------

Text pre-processing package to aid in NLP package development for Python3. With this package you can order text cleaning functions in the order you prefer rather than relying on the order of an arbitrary NLP package.
Text pre-processing package to aid in NLP package development for Python3. With this package you
can order text cleaning functions in the order you prefer rather than relying on the order of an
arbitrary NLP package.

Installation
------------
Expand Down Expand Up @@ -62,22 +64,25 @@ Once you have the package installed, implementing it with Python3 takes the foll
>>> print(clean_string)
"important string"

Should the functions be performed in a different order (i.e. keyword_tokenize - remove_urls - remove_non_bound_punct) :
Should the functions be performed in a different order (i.e. keyword_tokenize -> remove_urls ->
remove_non_bound_punct) :

>>> print(clean_string)
"important string http example.com"

Organisation
------------

This package is comprised of a single module with no intended subpackages currently. The *preprocessing* package is dependent on NLTK for tokenizers and stopwords. However, ignoring this, the package only has built-in dependencies from Python 3.
This package is comprised of a single module with no intended subpackages currently. The
*preprocessing* package is dependent on NLTK for tokenizers and stopwords. However, ignoring this,
the package only has built-in dependencies from Python 3.

Contributing
------------

If you feel like contributing:

* `Check for open issues <https://github.com/mwtmurphy/pre-processing/issues>`_ or open a new issue
* `Check for open issues <https://github.com/SpotlightData/preprocessing/issues>`_ or open a new issue
* Fork the preprocessing repository to start making your changes
* Write a test which shows the bug was fixed or that the feature works as expected
* Send a pull request and remember to add yourself to `CONTRIBUTORS.md <https://github.com/SpotlightData/preprocessing/blob/master/CONTRIBUTORS.md>`_
Expand Down

0 comments on commit 1207ea5

Please sign in to comment.