Skip to content

Commit fd66b46

Browse files
committed
Minor fixes/updates
1 parent 4623ed8 commit fd66b46

File tree

2 files changed

+6
-9
lines changed

2 files changed

+6
-9
lines changed

docs/contributing.rst

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Contributing
22
============
33

4-
A list of issues and ongoing work is available on the Label Maker `issues page <https://github.com/developmentseed/label-maker/issues>`_.
4+
A list of issues and ongoing work is available on the Label Maker `issues page <https://github.com/developmentseed/label-maker/issues>`_. If you want to contribute code, the best way is to coordinate with the core developers via an issue or pull request conversation.
55

66
Development installation
77
^^^^^^^^^^^^^^^^^^^^^^^^
@@ -13,8 +13,6 @@ Fork Label Maker into your Github account. Then, clone the repo and install it l
1313
$ cd label-maker
1414
$ pip install -e .
1515
16-
TODO: Double check that the above is correct
17-
1816
Testing
1917
^^^^^^^
2018
Label Maker runs tests using ``unittest``. You can find unit tests at ``tests/unit`` and integration tests at ``tests/integration``.
@@ -25,12 +23,10 @@ Run a single test with:
2523
2624
python -m unittest test/unit/test_validate.py
2725
28-
or an entire folder using
26+
or an entire folder using:
2927

3028
.. code-block:: bash
3129
3230
python -m unittest discover -v -s test/unit
3331
34-
More details on using ``unittest`` are `here <https://docs.python.org/3/library/unittest.html>`_.
35-
36-
TODO: double check that running unittests on a folder is correct as written
32+
More details on using ``unittest`` are `here <https://docs.python.org/3/library/unittest.html>`_.

docs/examples.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
1-
########
21
Examples
32
########
43

5-
Move examples from `here <https://github.com/developmentseed/label-maker/tree/master/examples>`_
4+
Examples live `here <https://github.com/developmentseed/label-maker/tree/master/examples>`_
5+
6+
ToDo: move these to their own page within this docs website.

0 commit comments

Comments
 (0)