Skip to content

Commit 7169830

Browse files
datapythonistajorisvandenbossche
authored andcommitted
DOC: Adding guide for the pandas documentation sprint (#19704)
1 parent 59c6dd4 commit 7169830

File tree

2 files changed

+913
-6
lines changed

2 files changed

+913
-6
lines changed

doc/source/contributing.rst

+3-6
Original file line numberDiff line numberDiff line change
@@ -293,12 +293,9 @@ Some other important things to know about the docs:
293293
overviews per topic together with some other information (what's new,
294294
installation, etc).
295295

296-
- The docstrings follow the **Numpy Docstring Standard**, which is used widely
297-
in the Scientific Python community. This standard specifies the format of
298-
the different sections of the docstring. See `this document
299-
<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_
300-
for a detailed explanation, or look at some of the existing functions to
301-
extend it in a similar manner.
296+
- The docstrings follow a pandas convention, based on the **Numpy Docstring
297+
Standard**. Follow the :ref:`pandas docstring guide <docstring>` for detailed
298+
instructions on how to write a correct docstring.
302299

303300
- The tutorials make heavy use of the `ipython directive
304301
<http://matplotlib.org/sampledoc/ipython_directive.html>`_ sphinx extension.

0 commit comments

Comments
 (0)