on improving the `pandas API documentation

<https://pandas.pydata.org/pandas-docs/stable/api.html>`_.

the API documentation could in many cases be better. Many of the `DataFrame`

or `Series` methods for example, are documented with simply a one liner

summary. In some cases, the documented parameters are not up to date with

There are around 1,000 API pages in pandas, meaning that the effort to fix,

standardize and improve all the API documentation is huge. But the pandas

So, we will work together from all around the world to take care of every

single API, in a single day.

and surely one of them works in a company happy to offer the venue.

If that does not work for you, universities, local government agencies

co-working spaces, could be interested in offering you a venue. In general,

it is easier to get a positive answer by trying to directly contact someone

there, than by filling a form or sending an email to info@whatever.

opportunity for them, to get their company promoted.

If nothing else works, you can find a bar, pub, restaurant... with some quiet

we will find a solution.

The local community and publishing the event

* Non male (which does not necessarily mean female)

* People over an age (50 year old?)

We do not recommend asking people for their race, sexual orientation,

religion... in order to find people from underrepresented minorities. We find

* Inside your local copy of the repo (`cd python-sprints.github.io`)...

* Create a branch for your changes: `git checkout -b adding_<your-city>_chapter`

* Edit the file with the chapter info: `vim pandas/index.html` and add an entry with the same fields as the rest

* Commit your changes: `git commit -m "Adding <your-city> to the pandas sprint page"`

* Push your changes to your fork: `git push -u origin adding_<your-city>_chapter`

* Create a pull request by clicking on the "Compare & pull request" button in the yellow box at https://github.com/python-sprints/python-sprints.github.io

than quantity**. For pandas, it will be much more productive if we send

50 excellent pull requests, than if we send 500 not so good pull requests.

while with their experience they will surely provide great reviews to

enrich our contributions, we surely do not want to waste their time by reviewing

code that doesn't work, spelling mistakes, bad grammar, incorrect text, or

so programmers can understand what it does without having to read the details

of the implementation.

automatically from docstrings. `Sphinx <http://www.sphinx-doc.org>`_ serves

this purpose.

Note that in "Returns" and "Yields", the description is located in the

following line than the type. But in this section it is located in the same

line, with a colon in between. If the description does not fit in the same

For example:

2. Visual validation of the docstring

that there are dots, spaces, or blank lines in the right side. But does

not validate for typos, unclear sentences, or other mistakes. To validate

them, as well as the visualization of your docstring in the pandas website

If the current branch is `master`, do not commit your changes, as you can get

into a situation where you need to undo your history in git, which is not

Then, follow the next steps:

where `<modified-file(s)>` is the file where you made your changes (in rare

cases it could be more than one file). And `<commit-message>` is a short

description of your changes, starting by "DOC:" (e.g. "DOC: Improved the

5. Push your changes to pandas

* An editor (vim, emacs, PyCharm,...). Make sure the editor is set up to use 4 spaces for tabs.

The `pandas contributing guide <https://pandas.pydata.org/pandas-docs/stable/contributing.html>`_

This document is a short summary with some additional information specific to

the sprint.

via pip, conda or a zip.

To get the latest development version:

* Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button

* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:

Then, set the upstream remote, so you can fetch the updates from the pandas

repository:

| ``git remote add upstream https://github.com/pandas-dev/pandas``

3. Set up a Python environment

}

div.sphinxsidebar #searchbox input[type="text"] {

}

img {

border: 0;

max-width: 100%;

div.body p, div.body dd, div.body li, div.body blockquote {

-moz-hyphens: auto;

-ms-hyphens: auto;

border-collapse: collapse;

}

table caption span.caption-number {

font-style: italic;

}

li.hide();

// Determine where in the parents children list to insert this comment.

if (comp(comment, siblings[i]) <= 0) {

$('#cd' + siblings[i].id)

.parent()

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Pandas documentation sprint &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />

<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" src="_static/jquery.js"></script>

<script type="text/javascript" src="_static/underscore.js"></script>

<script type="text/javascript" src="_static/doctools.js"></script>

<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

<div class="document">

<p>The pandas documentation sprint is a worldwide event that will take place

the 10th of March of 2018. During the sprint open source hackers will work

on improving the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/api.html">pandas API documentation</a>.</p>

the API documentation could in many cases be better. Many of the <cite>DataFrame</cite>

or <cite>Series</cite> methods for example, are documented with simply a one liner

summary. In some cases, the documented parameters are not up to date with

the actual method parameters. And while docstrings use the numpy docstring

convention, they could benefit from some pandas specific convention.</p>

<p>There are around 1,000 API pages in pandas, meaning that the effort to fix,

standardize and improve all the API documentation is huge. But the pandas

So, we will work together from all around the world to take care of every

single API, in a single day.</p>

<p>This document provides all the necessary information to participate to the

</div>

<div id="searchbox" style="display: none" role="search">

<h3>Quick search</h3>

<form class="search" action="search.html" method="get">

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

<script type="text/javascript">$('#searchbox').show(0);</script>

</div>

&copy;.

|

&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

|

<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Index &#8212; Python documentation</title>

<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />

<link rel="stylesheet" href="_static/pygments.css" type="text/css" />

<script type="text/javascript" src="_static/jquery.js"></script>

<script type="text/javascript" src="_static/underscore.js"></script>

<script type="text/javascript" src="_static/doctools.js"></script>

<meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" />

<div class="document">

<div class="sphinxsidebarwrapper">

<p class="logo"><a href="contents.html">

<img class="logo" src="_static/logo.png" alt="Logo"/>

<h3>Related Topics</h3>

<li><a href="contents.html">Documentation overview</a><ul>

</ul></li>

<div id="searchbox" style="display: none" role="search">

<h3>Quick search</h3>

<form class="search" action="search.html" method="get">

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

<script type="text/javascript">$('#searchbox').show(0);</script>

</div>

&copy;.

|

&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>