html files of the previous documents

Author: datapythonista

pandas/guide/_sources/contents.rst.txt

@@ -29,3 +29,4 @@ pandas documentation sprint.
 
    pandas_setup
    pandas_docstring
+   pandas_pr

pandas/guide/_sources/pandas_pr.rst.txt

@@ -0,0 +1,105 @@
+=======================
+Submitting your changes
+=======================
+
+Once you finished the changes to your assigned docstring, you can follow the
+instructions in this document in order to get your changes merged into pandas,
+and released in the next version.
+
+1. Validate that your docstring does not have technical errors
+--------------------------------------------------------------
+
+There is a script in pandas that validates whether a docstring follows the
+technical parts of the pandas docstring convention. To run the script,
+execute in your terminal:
+
+    | ``cd <pandas-dir>``
+    | ``scripts/validate_docstring.py <your-function-or-method>``
+
+where `<your-function-or-method>` is for example `pandas.DataFrame.head`,
+`pandas.Series.tail` or `pandas.to_datetime`.
+
+2. Visual validation of the docstring
+-------------------------------------
+
+The previous sprint validates things like the names of the sections, or
+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
+you need to generate the html version of the page you worked on.
+
+To build the documentation run:
+
+    | ``cd <pandas-dir>/doc``
+    | ``python make.py html --single <your-function-or-method>``
+
+where `<your-function-or-method>` follows the format described in the previous
+section.
+
+This will generate a file `<pandas-dir>/doc/build/html/generated/<your-function-or-method>.html`
+that can be opened with your web browser.
+
+3. Validate code in the examples
+--------------------------------
+
+Code in the `Examples` section of the docstring must be valid Python code, and
+return the exact output as presented. Besides illustrating the functionality
+in the documentation, this code is also part of the unit tests.
+
+To run the examples as unit tests, and validate that the code is correct and
+returns the expected output, execute the next in your terminal:
+
+    | ``cd <pandas-dir>``
+    | ``pytest --doctest-modules <file-of-your-docstring> -k <function-or-method-name>``
+
+where `<file-of-your-docstring>` is the path to the file where you edited your docstring
+(e.g. `pandas/core/frame.py`) and `<function-or-method-name>` is the name of the function
+or method you edited (e.g. `head`).
+
+4. Validate that the docstring is clear to others
+-------------------------------------------------
+
+As the last validation, please show the html version of your docstring to a
+person in the sprint not involved in the changes to the docstring, and make
+sure they are able to fully understand it.
+
+5. Commit your changes
+----------------------
+
+Once all the validations are successful, you can proceed to commit the changes
+into git.
+
+Before committing your changes, make sure you are in the branch of the feature
+you are going to commit with:
+
+    | ``git branch``
+
+Then, follow the next steps:
+
+    | ``git fetch upstream``
+    | ``git merge upstram/master``
+    | ``git add <modified-file(s)>``
+    | ``git commit -m "<commit-message>"``
+
+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
+docsting of DataFrame.head()").
+
+6. Push your changes to the sprint repository
+---------------------------------------------
+
+Before sending the pull request to the pandas core developers, you will send
+it to the sprint repository. Where more experienced contributors will review
+it, and suggest changes if needed.
+
+First, push your changes to your GitHub fork:
+
+    | ``git push -u origin <your-branch-name>``
+
+Then, visit https://github.com/python-sprints/pandas in your browser, and click
+on the "Compare & pull request" button in the yellow box above the repository
+files.
+
+Once your changes are reviewed and approved, you will receive an email on how
+to send the final pull request to pandas.

pandas/guide/_sources/pandas_setup.rst.txt

@@ -46,6 +46,11 @@ This will create a directory named `pandas`, containing the latest version of
 the source code. We will name this directory `<pandas-dir>` in the rest of
 this document.
 
+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
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 

pandas/guide/_sources/pr_instuctions.rst.txt

@@ -0,0 +1,43 @@
+============================
+How to create a pull request
+============================
+
+(a beginner's guide to use Github)
+---------------------------------
+
+So you want to join the Python Sprint, this quide will help you get started and know what you need to do to create a pull request (so you can contribute to cool open sourse project)
+
+=====================================================
+First you need a Github account if you don't have one
+=====================================================
+
+First you need to sign up for `Link Github <https://github.com>`. Github is a popular site for open source project to share the code and allow people to contribute to it. So it has a machanism to let people **frok** the repositries (which is "folder" containing all the files for the project), **clone** it to their local computer, **commit** to the online repositries then send a *pull request* to combine your contribution to the main one. Sounds complicated? Dont worry, we will walk you through it. So now go to `Link Github <https://github.com>` to get a **free account**.
+
+.. image:: LondonPython Sprints_internal_1.png
+
+=========================================
+Frok a repository (like a piece of cake!)
+=========================================
+
+Now you have a Github account, after logging in, go to the repository (or repo for short) that you are trying to contribute to (like, pandas). First thing you need to so it to **fork** it so you can have a copy for yourself, kinda like forking a piece of food to your own plate. (Just kidding)
+
+After you **fork** a repository, your copy will appear under your account haveing the same repo name (thus a **frok** is created). Reason for doing that is, since so many people is going to contribute to the open source repo, it make sense not giving permission for anyone to change the content of the original repo, so rather we will work on our own copy and ask for a **merge** by **pull request** whcih we will explain later.
+
+To **fork** a repository, just click the **fork** button on the top right
+
+.. image:: LondonPython Sprints_internal_2.png
+
+==============================================
+Now you can clone yourself... I mean your repo
+==============================================
+
+Okay, we have our lovely version of the repo at Github, but how can we work on it? Although Github provide certain way you can make changes to the content of your repo via the web interface, most of the project we need to do it on a local machine (like, your laptop).The way to go is to **clone** your online repor on Github to your computer. You may do it using Git whcih you can get it here: `<https://git-scm.com/downloads>` or Github now have Github Desktop whcih is also a local version of Git:`< https://desktop.github.com/>`
+
+Git is a version control software that will *record* different version of a project folder so it allows you to:
+1. you changed your mind and want to roll back to an earlier *save* or 
+2. you want to try something out and make an other *save copy* so you keep the original version.
+It's like when you play video games and make some safty save just in case you make some stupid mistake or make multiple save files so you can see different endings :-)
+
+Once you have install Git (or Github desktop) you can go to your repo (that's right, the repo that is under your account) and press the green **clone or download** button and copy the link there. With the link, you can use the GUI to clone the repo from Github to your machine or another way to do it is to use Git Bash ( or any other command line enviroment) following the steps below:
+
+(To be continued)

pandas/guide/contents.html

@@ -61,6 +61,7 @@ <h1>Pandas documentation sprint<a class="headerlink" href="#pandas-documentation
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="pandas_setup.html">Before the sprint: Set up instructions</a></li>
 <li class="toctree-l1"><a class="reference internal" href="pandas_docstring.html">How to write a good pandas docstring</a></li>
+<li class="toctree-l1"><a class="reference internal" href="pandas_pr.html">Submitting your changes</a></li>
 </ul>
 </div>
 </div>

pandas/guide/objects.inv

@@ -2,4 +2,5 @@
 # Project: Python
 # Version: 
 # The remainder of this file is compressed using zlib.
-x�m�A� E�=�\�&n�t��&=�A)	e��^Z�Q����?3Hr��#DV�"	�d�#Ozᔈ��4eU�!����S�\i+�h~SY��Dj'�_�f��T�X�N��ɑ�8���W�3��s0� @���Or�����T�z�;��X�`@���˒\�"6E���eE+5C�{��y	��
+x�mP͎!��S��īGO�a� T���XJԷ_�͎�|�m5� 	���!�=�}�2y8�`T��婠JH�]��bp��kv{uC_�����&2���-D����'���Ҝ����3~r��MO�';AP`�LWŸr�����]�mr"��M�A�*XL�7��a��p�;1��؏u�
+�e���K _�W�+f��fT�1{���I�����>p��N�?+��/i췟

pandas/guide/pandas_docstring.html

@@ -23,6 +23,7 @@
     <script type="text/javascript" src="_static/doctools.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Submitting your changes" href="pandas_pr.html" />
     <link rel="prev" title="Before the sprint: Set up instructions" href="pandas_setup.html" />
 
   <link rel="stylesheet" href="_static/custom.css" type="text/css" />
@@ -405,6 +406,7 @@ <h3>Related Topics</h3>
 <ul>
   <li><a href="contents.html">Documentation overview</a><ul>
       <li>Previous: <a href="pandas_setup.html" title="previous chapter">Before the sprint: Set up instructions</a></li>
+      <li>Next: <a href="pandas_pr.html" title="next chapter">Submitting your changes</a></li>
   </ul></li>
 </ul>
 </div>