Typo fixed in docstring guide, adding more info on how to send the PR

datapythonista · datapythonista · commit 97c3e63eabde · 2018-03-08T01:10:12.000Z
diff --git a/pandas/guide/_sources/pandas_docstring.rst.txt b/pandas/guide/_sources/pandas_docstring.rst.txt
@@ -777,6 +777,8 @@ positional arguments `head(3)`.
             2     True
             3    False
             dtype: bool
+            """
+            pass
 
 **Bad:**
 
diff --git a/pandas/guide/_sources/pandas_pr.rst.txt b/pandas/guide/_sources/pandas_pr.rst.txt
@@ -103,9 +103,34 @@ Then, visit https://github.com/pandas-dev/pandas in your browser, and click
 on the "Compare & pull request" button in the yellow box above the repository
 files.
 
-This will create a pull request, will be reviewed by other developers. It is
-unlikely that a pull request is accepted in its first version, so expect some
-comments on things that can be improved, from more senior pandas contributors.
+If you have only one commit, the pull request will automatically use its
+comment as title. Otherwise, please name it following the same standard as
+described before (e.g. "DOC: Improved the docstring of DataFrame.head()").
+In the body of the description, there are some checkboxes. For the sprint,
+we do not have an issue for each docstring change, and as we are not changing
+code, we do not need to add/run tests or add a `whatsnew` entry. So you can
+ignore these check boxes. Just verify that your changes respect the PEP-8
+style by running the command:
+
+    | ``git diff upstream/master -u -- "*.py" | flake8 --diff``
+
+If the command does not return any warning, mark that checkbox with an X (do
+not leave spaces inside the brackets, use `[X]`). If it returns a warning,
+fix it, commit your changes, and push to your remote branch before opening
+the pull request.
+
+After the checklist, please **copy the output of the validate_docstrings.py
+script**. This will help reviewers see the rendered docstring, as well as
+identify any validation problem.
+
+This will create a pull request, and other developers will review it.
+
+Updating a pull request
+~~~~~~~~~~~~~~~~~~~~~~~
+
+It is unlikely that a pull request is accepted in its first version, so expect
+some comments on things that can be improved, from more senior pandas
+contributors.
 
 For comments in your review, you can make new changes in your local branch for
 that pull request. And once you addressed all the comments, you can commit them
diff --git a/pandas/guide/pandas_docstring.html b/pandas/guide/pandas_docstring.html
@@ -676,44 +676,46 @@ <h2>About docstrings and standards<a class="headerlink" href="#about-docstrings-
         <span class="k">pass</span>
 
     <span class="k">def</span> <span class="nf">contains</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">pattern</span><span class="p">,</span> <span class="n">case_sensitive</span><span class="o">=</span><span class="bp">True</span><span class="p">,</span> <span class="n">na</span><span class="o">=</span><span class="n">numpy</span><span class="o">.</span><span class="n">nan</span><span class="p">):</span>
-        <span class="s2">&quot;&quot;&quot;</span>
-<span class="s2">        Return whether each value contains `pattern`.</span>
-
-<span class="s2">        In this case, we are illustrating how to use sections, even</span>
-<span class="s2">        if the example is simple enough and does not require them.</span>
-
-<span class="s2">        Examples</span>
-<span class="s2">        --------</span>
-<span class="s2">        &gt;&gt;&gt; s = pd.Series(&#39;Antelope&#39;, &#39;Lion&#39;, &#39;Zebra&#39;, numpy.nan)</span>
-<span class="s2">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;)</span>
-<span class="s2">        0    False</span>
-<span class="s2">        1    False</span>
-<span class="s2">        2     True</span>
-<span class="s2">        3      NaN</span>
-<span class="s2">        dtype: bool</span>
-
-<span class="s2">        **Case sensitivity**</span>
-
-<span class="s2">        With `case_sensitive` set to `False` we can match `a` with both</span>
-<span class="s2">        `a` and `A`:</span>
-
-<span class="s2">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;, case_sensitive=False)</span>
-<span class="s2">        0     True</span>
-<span class="s2">        1    False</span>
-<span class="s2">        2     True</span>
-<span class="s2">        3      NaN</span>
-<span class="s2">        dtype: bool</span>
-
-<span class="s2">        **Missing values**</span>
-
-<span class="s2">        We can fill missing values in the output using the `na` parameter:</span>
-
-<span class="s2">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;, na=False)</span>
-<span class="s2">        0    False</span>
-<span class="s2">        1    False</span>
-<span class="s2">        2     True</span>
-<span class="s2">        3    False</span>
-<span class="s2">        dtype: bool</span>
+        <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">        Return whether each value contains `pattern`.</span>
+
+<span class="sd">        In this case, we are illustrating how to use sections, even</span>
+<span class="sd">        if the example is simple enough and does not require them.</span>
+
+<span class="sd">        Examples</span>
+<span class="sd">        --------</span>
+<span class="sd">        &gt;&gt;&gt; s = pd.Series(&#39;Antelope&#39;, &#39;Lion&#39;, &#39;Zebra&#39;, numpy.nan)</span>
+<span class="sd">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;)</span>
+<span class="sd">        0    False</span>
+<span class="sd">        1    False</span>
+<span class="sd">        2     True</span>
+<span class="sd">        3      NaN</span>
+<span class="sd">        dtype: bool</span>
+
+<span class="sd">        **Case sensitivity**</span>
+
+<span class="sd">        With `case_sensitive` set to `False` we can match `a` with both</span>
+<span class="sd">        `a` and `A`:</span>
+
+<span class="sd">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;, case_sensitive=False)</span>
+<span class="sd">        0     True</span>
+<span class="sd">        1    False</span>
+<span class="sd">        2     True</span>
+<span class="sd">        3      NaN</span>
+<span class="sd">        dtype: bool</span>
+
+<span class="sd">        **Missing values**</span>
+
+<span class="sd">        We can fill missing values in the output using the `na` parameter:</span>
+
+<span class="sd">        &gt;&gt;&gt; s.contains(pattern=&#39;a&#39;, na=False)</span>
+<span class="sd">        0    False</span>
+<span class="sd">        1    False</span>
+<span class="sd">        2     True</span>
+<span class="sd">        3    False</span>
+<span class="sd">        dtype: bool</span>
+<span class="sd">        &quot;&quot;&quot;</span>
+        <span class="k">pass</span>
 </pre></div>
 </div>
 <p><strong>Bad:</strong></p>
diff --git a/pandas/guide/pandas_pr.html b/pandas/guide/pandas_pr.html
@@ -134,9 +134,32 @@ <h2>5. Push your changes to pandas<a class="headerlink" href="#push-your-changes
 <p>Then, visit <a class="reference external" href="https://github.com/pandas-dev/pandas">https://github.com/pandas-dev/pandas</a> in your browser, and click
 on the “Compare &amp; pull request” button in the yellow box above the repository
 files.</p>
-<p>This will create a pull request, will be reviewed by other developers. It is
-unlikely that a pull request is accepted in its first version, so expect some
-comments on things that can be improved, from more senior pandas contributors.</p>
+<p>If you have only one commit, the pull request will automatically use its
+comment as title. Otherwise, please name it following the same standard as
+described before (e.g. “DOC: Improved the docstring of DataFrame.head()”).
+In the body of the description, there are some checkboxes. For the sprint,
+we do not have an issue for each docstring change, and as we are not changing
+code, we do not need to add/run tests or add a <cite>whatsnew</cite> entry. So you can
+ignore these check boxes. Just verify that your changes respect the PEP-8
+style by running the command:</p>
+<blockquote>
+<div><div class="line-block">
+<div class="line"><code class="docutils literal"><span class="pre">git</span> <span class="pre">diff</span> <span class="pre">upstream/master</span> <span class="pre">-u</span> <span class="pre">--</span> <span class="pre">&quot;*.py&quot;</span> <span class="pre">|</span> <span class="pre">flake8</span> <span class="pre">--diff</span></code></div>
+</div>
+</div></blockquote>
+<p>If the command does not return any warning, mark that checkbox with an X (do
+not leave spaces inside the brackets, use <cite>[X]</cite>). If it returns a warning,
+fix it, commit your changes, and push to your remote branch before opening
+the pull request.</p>
+<p>After the checklist, please <strong>copy the output of the validate_docstrings.py
+script</strong>. This will help reviewers see the rendered docstring, as well as
+identify any validation problem.</p>
+<p>This will create a pull request, and other developers will review it.</p>
+<div class="section" id="updating-a-pull-request">
+<h3>Updating a pull request<a class="headerlink" href="#updating-a-pull-request" title="Permalink to this headline">¶</a></h3>
+<p>It is unlikely that a pull request is accepted in its first version, so expect
+some comments on things that can be improved, from more senior pandas
+contributors.</p>
 <p>For comments in your review, you can make new changes in your local branch for
 that pull request. And once you addressed all the comments, you can commit them
 and push again to your local branch. As you used the parameter <cite>-u</cite> in your
@@ -160,6 +183,7 @@ <h2>5. Push your changes to pandas<a class="headerlink" href="#push-your-changes
 learn more. So, be patient and enjoy. And feel free to provide constructive
 feedback in other contributors pull requests too.</p>
 </div>
+</div>
 </div>
 
 
@@ -178,7 +202,10 @@ <h3><a href="contents.html">Table Of Contents</a></h3>
 <li><a class="reference internal" href="#visual-validation-of-the-docstring">2. Visual validation of the docstring</a></li>
 <li><a class="reference internal" href="#validate-that-the-docstring-is-clear-to-others">3. Validate that the docstring is clear to others</a></li>
 <li><a class="reference internal" href="#commit-your-changes">4. Commit your changes</a></li>
-<li><a class="reference internal" href="#push-your-changes-to-pandas">5. Push your changes to pandas</a></li>
+<li><a class="reference internal" href="#push-your-changes-to-pandas">5. Push your changes to pandas</a><ul>
+<li><a class="reference internal" href="#updating-a-pull-request">Updating a pull request</a></li>
+</ul>
+</li>
 </ul>
 </li>
 </ul>
diff --git a/pandas/guide/searchindex.js b/pandas/guide/searchindex.js
diff --git a/pandas/guide/source/pandas_docstring.rst b/pandas/guide/source/pandas_docstring.rst
@@ -777,6 +777,8 @@ positional arguments `head(3)`.
             2     True
             3    False
             dtype: bool
+            """
+            pass
 
 **Bad:**
 
diff --git a/pandas/guide/source/pandas_pr.rst b/pandas/guide/source/pandas_pr.rst
@@ -103,9 +103,34 @@ Then, visit https://github.com/pandas-dev/pandas in your browser, and click
 on the "Compare & pull request" button in the yellow box above the repository
 files.
 
-This will create a pull request, will be reviewed by other developers. It is
-unlikely that a pull request is accepted in its first version, so expect some
-comments on things that can be improved, from more senior pandas contributors.
+If you have only one commit, the pull request will automatically use its
+comment as title. Otherwise, please name it following the same standard as
+described before (e.g. "DOC: Improved the docstring of DataFrame.head()").
+In the body of the description, there are some checkboxes. For the sprint,
+we do not have an issue for each docstring change, and as we are not changing
+code, we do not need to add/run tests or add a `whatsnew` entry. So you can
+ignore these check boxes. Just verify that your changes respect the PEP-8
+style by running the command:
+
+    | ``git diff upstream/master -u -- "*.py" | flake8 --diff``
+
+If the command does not return any warning, mark that checkbox with an X (do
+not leave spaces inside the brackets, use `[X]`). If it returns a warning,
+fix it, commit your changes, and push to your remote branch before opening
+the pull request.
+
+After the checklist, please **copy the output of the validate_docstrings.py
+script**. This will help reviewers see the rendered docstring, as well as
+identify any validation problem.
+
+This will create a pull request, and other developers will review it.
+
+Updating a pull request
+~~~~~~~~~~~~~~~~~~~~~~~
+
+It is unlikely that a pull request is accepted in its first version, so expect
+some comments on things that can be improved, from more senior pandas
+contributors.
 
 For comments in your review, you can make new changes in your local branch for
 that pull request. And once you addressed all the comments, you can commit them
