Skip to content

Commit 83884a1

Browse files
authored
Update link to NumPy docstring standard in contributing guide (#4558)
* Update link to NumPy docstring standard * Add whats-new entry
1 parent ef910b9 commit 83884a1

File tree

2 files changed

+3
-1
lines changed

2 files changed

+3
-1
lines changed

doc/contributing.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Some other important things to know about the docs:
252252
- The docstrings follow the **Numpy Docstring Standard**, which is used widely
253253
in the Scientific Python community. This standard specifies the format of
254254
the different sections of the docstring. See `this document
255-
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
255+
<https://numpydoc.readthedocs.io/en/latest/format.html#docstring-standard>`_
256256
for a detailed explanation, or look at some of the existing functions to
257257
extend it in a similar manner.
258258

doc/whats-new.rst

+2
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ Documentation
7272
By `Sahid Velji <https://github.com/sahidvelji>`_.
7373
- Fix grammar and typos in the :doc:`io` guide (:pull:`4553`).
7474
By `Sahid Velji <https://github.com/sahidvelji>`_.
75+
- Update link to NumPy docstring standard in the :doc:`contributing` guide (:pull:`4558`).
76+
By `Sahid Velji <https://github.com/sahidvelji>`_.
7577

7678
Internal Changes
7779
~~~~~~~~~~~~~~~~

0 commit comments

Comments
 (0)