Skip to content

Fixed multiple typos in the guides #51

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.

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 2 commits into from
Mar 5, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions pandas/guide/_sources/contents.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ the 10th of March of 2018. During the sprint open source hackers will work
on improving the `pandas API documentation
<https://pandas.pydata.org/pandas-docs/stable/api.html>`_.

While most of pandas documentation is great, very extense, and easy to follow,
While most of pandas documentation is great, very extensive, and easy to follow,
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
Expand All @@ -16,7 +16,7 @@ convention, they could benefit from some pandas specific convention.

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
user base is also huge. And Pythonistas are very active an well organized.
user base is also huge. And Pythonistas are very active and well organized.
So, we will work together from all around the world to take care of every
single API, in a single day.

Expand Down
10 changes: 5 additions & 5 deletions pandas/guide/_sources/organizers.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ it again. If that is not the case, they can mail the members of the community,
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
supporting employment and enterpreneurship, startup incubators, and
supporting employment and entrepreneurship, startup incubators, and
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.
Expand All @@ -50,7 +50,7 @@ Python programmers and data scientists are hard to find, and it can be a great
opportunity for them, to get their company promoted.

If nothing else works, you can find a bar, pub, restaurant... with some quiet
area for the spint. And if you do not even find that, please contact us, and
area for the sprint. And if you do not even find that, please contact us, and
we will find a solution.

The local community and publishing the event
Expand Down Expand Up @@ -109,7 +109,7 @@ consider:

* Non male (which does not necessarily mean female)
* People over an age (50 year old?)
* Ethnical background depending on where you are
* Ethnic background depending on where you are

We do not recommend asking people for their race, sexual orientation,
religion... in order to find people from underrepresented minorities. We find
Expand Down Expand Up @@ -142,7 +142,7 @@ In short:
* 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
* Add your changed to be commited: `git add pandas/index.html`
* Add your changed to be committed: `git add pandas/index.html`
* 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
Expand Down Expand Up @@ -212,7 +212,7 @@ One important thing to consider, is that **quality is much more important
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.

Core developers are usually the bottle neck of open source projects. And
Core developers are usually the bottleneck of open source projects. And
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
Expand Down
12 changes: 6 additions & 6 deletions pandas/guide/_sources/pandas_docstring.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ A Python docstring is a string used to document a Python function or method,
so programmers can understand what it does without having to read the details
of the implementation.

Also, it is a commonn practice to generate online (html) documentation
Also, it is a common practice to generate online (html) documentation
automatically from docstrings. `Sphinx <http://www.sphinx-doc.org>`_ serves
this purpose.

Expand Down Expand Up @@ -280,8 +280,8 @@ all cpus).".
specified kind.

Note the blank line between the parameters title and the first
parameter. Also, not that after the name of the parameter `kind`
and before the colo, a space is missing.
parameter. Also, note that after the name of the parameter `kind`
and before the colon, a space is missing.

Also, note that the parameter descriptions do not start with a
capital letter, and do not finish with a dot.
Expand Down Expand Up @@ -386,7 +386,7 @@ For example, with a single value:
def sample():
"""Generate and return a random number.

The value is sampled from a continuos uniform distribution between
The value is sampled from a continuous uniform distribution between
0 and 1.

Returns
Expand Down Expand Up @@ -425,7 +425,7 @@ If the method yields its value:
def sample_values():
"""Generate an infinite sequence of random numbers.

The values are sampled from a continuos uniform distribution between
The values are sampled from a continuous uniform distribution between
0 and 1.

Yields
Expand Down Expand Up @@ -487,7 +487,7 @@ the one referencing. The description must also finish with a dot.
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
line, it can continue in the next ones, but it has to be indenteted in them.
line, it can continue in the next ones, but it has to be indented in them.

For example:

Expand Down
6 changes: 3 additions & 3 deletions pandas/guide/_sources/pandas_pr.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ With few exceptions, you should fix all the errors before continuing.
2. Visual validation of the docstring
-------------------------------------

The previous sprint validates things like the names of the sections, or
The previous script 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
Expand Down Expand Up @@ -74,7 +74,7 @@ you are going to commit with:

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
straight forward.
straightforward.

Then, follow the next steps:

Expand All @@ -86,7 +86,7 @@ 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
docsting of DataFrame.head()").
docstring of DataFrame.head()").

5. Push your changes to pandas
------------------------------
Expand Down
4 changes: 1 addition & 3 deletions pandas/guide/_sources/pandas_setup.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You need the next software installed:
* 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>`_
contains detailed instructions on how to set up a pandas devlopment environemnt.
contains detailed instructions on how to set up a pandas development environment.
This document is a short summary with some additional information specific to
the sprint.

Expand All @@ -37,7 +37,6 @@ version of pandas. Do not make them to a version downloaded from the Internet
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:

Expand All @@ -50,7 +49,6 @@ this document.
Then, set the upstream remote, so you can fetch the updates from the pandas
repository:

| ``cd <pandas-dir>``
| ``git remote add upstream https://github.com/pandas-dev/pandas``

3. Set up a Python environment
Expand Down
24 changes: 23 additions & 1 deletion pandas/guide/_static/basic.css
Original file line number Diff line number Diff line change
Expand Up @@ -82,9 +82,21 @@ div.sphinxsidebar input {
}

div.sphinxsidebar #searchbox input[type="text"] {
width: 170px;
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}

div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}


img {
border: 0;
max-width: 100%;
Expand Down Expand Up @@ -199,6 +211,11 @@ table.modindextable td {

/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
max-width: 800px;
}

div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
Expand Down Expand Up @@ -332,6 +349,11 @@ table.docutils {
border-collapse: collapse;
}

table.align-center {
margin-left: auto;
margin-right: auto;
}

table caption span.caption-number {
font-style: italic;
}
Expand Down
8 changes: 4 additions & 4 deletions pandas/guide/_static/jquery.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion pandas/guide/_static/websupport.js
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@
li.hide();

// Determine where in the parents children list to insert this comment.
for(i=0; i < siblings.length; i++) {
for(var i=0; i < siblings.length; i++) {
if (comp(comment, siblings[i]) <= 0) {
$('#cd' + siblings[i].id)
.parent()
Expand Down
27 changes: 10 additions & 17 deletions pandas/guide/contents.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,20 +4,12 @@

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/documentation_options.js"></script>
<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>
Expand All @@ -30,8 +22,7 @@

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

</head>
<body>
</head><body>


<div class="document">
Expand All @@ -44,15 +35,15 @@ <h1>Pandas documentation sprint<a class="headerlink" href="#pandas-documentation
<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>
<p>While most of pandas documentation is great, very extense, and easy to follow,
<p>While most of pandas documentation is great, very extensive, and easy to follow,
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
user base is also huge. And Pythonistas are very active an well organized.
user base is also huge. And Pythonistas are very active and well organized.
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
Expand Down Expand Up @@ -91,12 +82,14 @@ <h3>This Page</h3>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
Expand All @@ -107,7 +100,7 @@ <h3>Quick search</h3>
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

|
Expand Down
28 changes: 9 additions & 19 deletions pandas/guide/genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,20 +5,12 @@

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<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">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: './',
VERSION: '',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="_static/documentation_options.js"></script>
<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>
Expand All @@ -30,8 +22,7 @@

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

</head>
<body>
</head><body>


<div class="document">
Expand All @@ -54,24 +45,23 @@ <h1 id="index">Index</h1>
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="contents.html">
<img class="logo" src="_static/logo.png" alt="Logo"/>
</a></p>

<div class="relations">
</a></p><div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="contents.html">Documentation overview</a><ul>
</ul></li>
</ul>
</div>

<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
Expand All @@ -82,7 +72,7 @@ <h3>Quick search</h3>
&copy;.

|
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.6.6</a>
Powered by <a href="http://sphinx-doc.org/">Sphinx 1.7.1</a>
&amp; <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.10</a>

</div>
Expand Down
Loading