Skip to content

DOC: Adding guide for the pandas documentation sprint #19704

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 12, 2018
Merged

DOC: Adding guide for the pandas documentation sprint #19704

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
c625da5
DOC: Adding guide for the pandas documentation sprint
datapythonista Feb 14, 2018
97dd08d
Made changes addressing comments in the different reviews
datapythonista Feb 25, 2018
9b275ac
Adding comment on why the original numpy docstring convention is refe…
datapythonista Feb 25, 2018
8e558b0
removing note saying that examples are unit tests
datapythonista Feb 25, 2018
0598a79
Addressing comments from reviews, and linking the docstring guide fro…
datapythonista Feb 28, 2018
b170a73
Latest updates from sprint website
jorisvandenbossche Mar 7, 2018
96da2c8
Updating contributing_docstring.rst with the last changes, and some f…
datapythonista Mar 8, 2018
cd43d82
Merging
datapythonista Mar 8, 2018
5ebac55
synchronize with sprint version
jorisvandenbossche Mar 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 3 additions & 6 deletions doc/source/contributing.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -292,12 +292,9 @@ Some other important things to know about the docs:
overviews per topic together with some other information (what's new,
installation, etc).

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

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