Skip to content

Commit 684a5b7

Browse files
committed
Update CONTRIBUTING in light of docstub
Proofread contribution guidelines for array docstring and dataset references.
1 parent acd84c7 commit 684a5b7

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

CONTRIBUTING.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ Stylistic Guidelines
216216
* Use numpy data types instead of strings (``np.uint8`` instead of
217217
``"uint8"``).
218218

219-
* When documenting array parameters, use ``image : (M, N) ndarray``
219+
* When documenting array parameters, use ``image : ndarray of shape (M, N)``
220220
and then refer to ``M`` and ``N`` in the docstring, if necessary.
221221

222222
* Refer to array dimensions as (plane), row, column, not as x, y, z. See
@@ -502,12 +502,12 @@ to perform the above procedure.
502502

503503
Adding Data
504504
-----------
505-
While code is hosted on `github <https://github.com/scikit-image/>`_,
506-
example datasets are on `gitlab <https://gitlab.com/scikit-image/data>`_.
505+
While code is hosted on `GitHub <https://github.com/scikit-image/>`_,
506+
example datasets are on `GitLab <https://gitlab.com/scikit-image/data>`_.
507507
These are fetched with `pooch <https://github.com/fatiando/pooch>`_
508-
when accessing `skimage.data.*`.
508+
when accessing ``skimage.data.*``.
509509

510-
New datasets are submitted on gitlab and, once merged, the data
510+
New datasets are submitted on GitLab and, once merged, the data
511511
registry ``skimage/data/_registry.py`` in the main GitHub repository
512512
can be updated.
513513

0 commit comments

Comments
 (0)