Skip to content

Commit d44f19f

Browse files
authored
Doc stuff and workflows (#7)
1 parent 3e09618 commit d44f19f

File tree

3 files changed

+17
-15
lines changed

3 files changed

+17
-15
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
GIT2CL ?= admin-tools/git2cl
88
PYTHON ?= python3
9-
PIP ?= pip3
9+
PIP ?= $(PYTHON) -m pip
1010
RM ?= rm
1111

1212
# Two-letter language code, e.g. fr, zh
@@ -50,7 +50,7 @@ install: pypi-setup
5050
$(PYTHON) setup.py install
5151

5252
#: Run tests
53-
check: pytest
53+
test check: pytest
5454

5555
#: Remove derived files
5656
clean: clean-pyc

pymathics/natlang/__init__.py

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
"""Pymathics Natlang
22
3-
This module provides Mathics functions and varialbles to work with
4-
expressions in natural language, using the libraries ``nltk`` and
5-
``spacy``.
6-
3+
This module provides Mathics functions and variables to work with \
4+
expressions in natural language, using the libraries 'nltk' and \
5+
'spacy'.
76
"""
87

98

pymathics/natlang/main.py

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,25 @@
11
# -*- coding: utf-8 -*-
22
# FIXME: split this up into smaller pieces
33

4-
"""Natural language functions.
4+
"""
5+
Natural language functions.
56
67
The following Python Packages are used:
78
8-
* ``spacy`` is used for parsing natural languages
9-
* ``nltk`` is used for functions using WordNet-related builtins
10-
* `langid``, and ``pycountry`` are used for ``LanguageIdentify[]``
11-
* ``pyenchant`` is used for SpellingCorrectionList[]
9+
<ul>
10+
<li> 'spacy' is used for parsing natural languages
11+
<li> 'nltk' is used for functions using WordNet-related builtins
12+
<li> 'langid', and `'pycountry' are used for 'LanguageIdentify[]'
13+
<li> 'pyenchant'` is used for 'SpellingCorrectionList[]'
14+
</ul>
1215
1316
User customization:
1417
15-
For nltk, use the environment variable NLTK_DATA to specify a custom
16-
data path (instead of $HOME/.nltk). For spacy, eset MATHICS3_SPACY_DATA,
17-
a Mathics3-specific variable.
18+
For nltk, use the environment variable NLTK_DATA to specify a custom \
19+
data path (instead of $HOME/.nltk). For spacy, set 'MATHICS3_SPACY_DATA', \
20+
a Mathics3-specific variable. \
1821
19-
In order to use the Extended Open Multilingual Wordnet (OMW) with NLTK
22+
In order to use the Extended Open Multilingual Wordnet (OMW) with 'NLTK'
2023
and use even more languages, you need to install them manually.
2124
2225
Go to http://compling.hss.ntu.edu.sg/omw/summx.html, download the

0 commit comments

Comments
 (0)