Skip to content

Commit e0720ae

Browse files
Merge remote-tracking branch 'origin/master'
2 parents 64d5b26 + e3dc396 commit e0720ae

23 files changed

+178
-212
lines changed

pandas/guide/_sources/contents.rst.txt

+2-2
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ the 10th of March of 2018. During the sprint open source hackers will work
77
on improving the `pandas API documentation
88
<https://pandas.pydata.org/pandas-docs/stable/api.html>`_.
99

10-
While most of pandas documentation is great, very extense, and easy to follow,
10+
While most of pandas documentation is great, very extensive, and easy to follow,
1111
the API documentation could in many cases be better. Many of the `DataFrame`
1212
or `Series` methods for example, are documented with simply a one liner
1313
summary. In some cases, the documented parameters are not up to date with
@@ -16,7 +16,7 @@ convention, they could benefit from some pandas specific convention.
1616

1717
There are around 1,000 API pages in pandas, meaning that the effort to fix,
1818
standardize and improve all the API documentation is huge. But the pandas
19-
user base is also huge. And Pythonistas are very active an well organized.
19+
user base is also huge. And Pythonistas are very active and well organized.
2020
So, we will work together from all around the world to take care of every
2121
single API, in a single day.
2222

pandas/guide/_sources/organizers.rst.txt

+5-5
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ it again. If that is not the case, they can mail the members of the community,
3434
and surely one of them works in a company happy to offer the venue.
3535

3636
If that does not work for you, universities, local government agencies
37-
supporting employment and enterpreneurship, startup incubators, and
37+
supporting employment and entrepreneurship, startup incubators, and
3838
co-working spaces, could be interested in offering you a venue. In general,
3939
it is easier to get a positive answer by trying to directly contact someone
4040
there, than by filling a form or sending an email to info@whatever.
@@ -50,7 +50,7 @@ Python programmers and data scientists are hard to find, and it can be a great
5050
opportunity for them, to get their company promoted.
5151

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

5656
The local community and publishing the event
@@ -109,7 +109,7 @@ consider:
109109

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

114114
We do not recommend asking people for their race, sexual orientation,
115115
religion... in order to find people from underrepresented minorities. We find
@@ -142,7 +142,7 @@ In short:
142142
* Inside your local copy of the repo (`cd python-sprints.github.io`)...
143143
* Create a branch for your changes: `git checkout -b adding_<your-city>_chapter`
144144
* Edit the file with the chapter info: `vim pandas/index.html` and add an entry with the same fields as the rest
145-
* Add your changed to be commited: `git add pandas/index.html`
145+
* Add your changed to be committed: `git add pandas/index.html`
146146
* Commit your changes: `git commit -m "Adding <your-city> to the pandas sprint page"`
147147
* Push your changes to your fork: `git push -u origin adding_<your-city>_chapter`
148148
* 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
@@ -212,7 +212,7 @@ One important thing to consider, is that **quality is much more important
212212
than quantity**. For pandas, it will be much more productive if we send
213213
50 excellent pull requests, than if we send 500 not so good pull requests.
214214

215-
Core developers are usually the bottle neck of open source projects. And
215+
Core developers are usually the bottleneck of open source projects. And
216216
while with their experience they will surely provide great reviews to
217217
enrich our contributions, we surely do not want to waste their time by reviewing
218218
code that doesn't work, spelling mistakes, bad grammar, incorrect text, or

pandas/guide/_sources/pandas_docstring.rst.txt

+6-6
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ A Python docstring is a string used to document a Python function or method,
1111
so programmers can understand what it does without having to read the details
1212
of the implementation.
1313

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

@@ -280,8 +280,8 @@ all cpus).".
280280
specified kind.
281281
282282
Note the blank line between the parameters title and the first
283-
parameter. Also, not that after the name of the parameter `kind`
284-
and before the colo, a space is missing.
283+
parameter. Also, note that after the name of the parameter `kind`
284+
and before the colon, a space is missing.
285285
286286
Also, note that the parameter descriptions do not start with a
287287
capital letter, and do not finish with a dot.
@@ -386,7 +386,7 @@ For example, with a single value:
386386
def sample():
387387
"""Generate and return a random number.
388388
389-
The value is sampled from a continuos uniform distribution between
389+
The value is sampled from a continuous uniform distribution between
390390
0 and 1.
391391
392392
Returns
@@ -425,7 +425,7 @@ If the method yields its value:
425425
def sample_values():
426426
"""Generate an infinite sequence of random numbers.
427427
428-
The values are sampled from a continuos uniform distribution between
428+
The values are sampled from a continuous uniform distribution between
429429
0 and 1.
430430
431431
Yields
@@ -487,7 +487,7 @@ the one referencing. The description must also finish with a dot.
487487
Note that in "Returns" and "Yields", the description is located in the
488488
following line than the type. But in this section it is located in the same
489489
line, with a colon in between. If the description does not fit in the same
490-
line, it can continue in the next ones, but it has to be indenteted in them.
490+
line, it can continue in the next ones, but it has to be indented in them.
491491

492492
For example:
493493

pandas/guide/_sources/pandas_pr.rst.txt

+3-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ With few exceptions, you should fix all the errors before continuing.
3737
2. Visual validation of the docstring
3838
-------------------------------------
3939

40-
The previous sprint validates things like the names of the sections, or
40+
The previous script validates things like the names of the sections, or
4141
that there are dots, spaces, or blank lines in the right side. But does
4242
not validate for typos, unclear sentences, or other mistakes. To validate
4343
them, as well as the visualization of your docstring in the pandas website
@@ -74,7 +74,7 @@ you are going to commit with:
7474
7575
If the current branch is `master`, do not commit your changes, as you can get
7676
into a situation where you need to undo your history in git, which is not
77-
straight forward.
77+
straightforward.
7878

7979
Then, follow the next steps:
8080

@@ -86,7 +86,7 @@ Then, follow the next steps:
8686
where `<modified-file(s)>` is the file where you made your changes (in rare
8787
cases it could be more than one file). And `<commit-message>` is a short
8888
description of your changes, starting by "DOC:" (e.g. "DOC: Improved the
89-
docsting of DataFrame.head()").
89+
docstring of DataFrame.head()").
9090

9191
5. Push your changes to pandas
9292
------------------------------

pandas/guide/_sources/pandas_setup.rst.txt

+1-3
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You need the next software installed:
1010
* An editor (vim, emacs, PyCharm,...). Make sure the editor is set up to use 4 spaces for tabs.
1111

1212
The `pandas contributing guide <https://pandas.pydata.org/pandas-docs/stable/contributing.html>`_
13-
contains detailed instructions on how to set up a pandas devlopment environemnt.
13+
contains detailed instructions on how to set up a pandas development environment.
1414
This document is a short summary with some additional information specific to
1515
the sprint.
1616

@@ -37,7 +37,6 @@ version of pandas. Do not make them to a version downloaded from the Internet
3737
via pip, conda or a zip.
3838

3939
To get the latest development version:
40-
4140
* Fork the `pandas repository <https://github.com/pandas-dev/pandas>`_ on GitHub by click on the top-right `Fork` button
4241
* In the terminal of your computer, in the directory where you want the copy of pandas source code, run:
4342

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

53-
| ``cd <pandas-dir>``
5452
| ``git remote add upstream https://github.com/pandas-dev/pandas``
5553
5654
3. Set up a Python environment

pandas/guide/_static/basic.css

+23-1
Original file line numberDiff line numberDiff line change
@@ -82,9 +82,21 @@ div.sphinxsidebar input {
8282
}
8383

8484
div.sphinxsidebar #searchbox input[type="text"] {
85-
width: 170px;
85+
float: left;
86+
width: 80%;
87+
padding: 0.25em;
88+
box-sizing: border-box;
89+
}
90+
91+
div.sphinxsidebar #searchbox input[type="submit"] {
92+
float: left;
93+
width: 20%;
94+
border-left: none;
95+
padding: 0.25em;
96+
box-sizing: border-box;
8697
}
8798

99+
88100
img {
89101
border: 0;
90102
max-width: 100%;
@@ -199,6 +211,11 @@ table.modindextable td {
199211

200212
/* -- general body styles --------------------------------------------------- */
201213

214+
div.body {
215+
min-width: 450px;
216+
max-width: 800px;
217+
}
218+
202219
div.body p, div.body dd, div.body li, div.body blockquote {
203220
-moz-hyphens: auto;
204221
-ms-hyphens: auto;
@@ -332,6 +349,11 @@ table.docutils {
332349
border-collapse: collapse;
333350
}
334351

352+
table.align-center {
353+
margin-left: auto;
354+
margin-right: auto;
355+
}
356+
335357
table caption span.caption-number {
336358
font-style: italic;
337359
}

pandas/guide/_static/jquery.js

+4-4
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pandas/guide/_static/websupport.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -301,7 +301,7 @@
301301
li.hide();
302302

303303
// Determine where in the parents children list to insert this comment.
304-
for(i=0; i < siblings.length; i++) {
304+
for(var i=0; i < siblings.length; i++) {
305305
if (comp(comment, siblings[i]) <= 0) {
306306
$('#cd' + siblings[i].id)
307307
.parent()

pandas/guide/contents.html

+10-17
Original file line numberDiff line numberDiff line change
@@ -4,20 +4,12 @@
44

55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
7+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
78
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
89
<title>Pandas documentation sprint &#8212; Python documentation</title>
910
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1011
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
11-
<script type="text/javascript">
12-
var DOCUMENTATION_OPTIONS = {
13-
URL_ROOT: './',
14-
VERSION: '',
15-
COLLAPSE_INDEX: false,
16-
FILE_SUFFIX: '.html',
17-
HAS_SOURCE: true,
18-
SOURCELINK_SUFFIX: '.txt'
19-
};
20-
</script>
12+
<script type="text/javascript" src="_static/documentation_options.js"></script>
2113
<script type="text/javascript" src="_static/jquery.js"></script>
2214
<script type="text/javascript" src="_static/underscore.js"></script>
2315
<script type="text/javascript" src="_static/doctools.js"></script>
@@ -30,8 +22,7 @@
3022

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

33-
</head>
34-
<body>
25+
</head><body>
3526

3627

3728
<div class="document">
@@ -44,15 +35,15 @@ <h1>Pandas documentation sprint<a class="headerlink" href="#pandas-documentation
4435
<p>The pandas documentation sprint is a worldwide event that will take place
4536
the 10th of March of 2018. During the sprint open source hackers will work
4637
on improving the <a class="reference external" href="https://pandas.pydata.org/pandas-docs/stable/api.html">pandas API documentation</a>.</p>
47-
<p>While most of pandas documentation is great, very extense, and easy to follow,
38+
<p>While most of pandas documentation is great, very extensive, and easy to follow,
4839
the API documentation could in many cases be better. Many of the <cite>DataFrame</cite>
4940
or <cite>Series</cite> methods for example, are documented with simply a one liner
5041
summary. In some cases, the documented parameters are not up to date with
5142
the actual method parameters. And while docstrings use the numpy docstring
5243
convention, they could benefit from some pandas specific convention.</p>
5344
<p>There are around 1,000 API pages in pandas, meaning that the effort to fix,
5445
standardize and improve all the API documentation is huge. But the pandas
55-
user base is also huge. And Pythonistas are very active an well organized.
46+
user base is also huge. And Pythonistas are very active and well organized.
5647
So, we will work together from all around the world to take care of every
5748
single API, in a single day.</p>
5849
<p>This document provides all the necessary information to participate to the
@@ -91,12 +82,14 @@ <h3>This Page</h3>
9182
</div>
9283
<div id="searchbox" style="display: none" role="search">
9384
<h3>Quick search</h3>
85+
<div class="searchformwrapper">
9486
<form class="search" action="search.html" method="get">
95-
<div><input type="text" name="q" /></div>
96-
<div><input type="submit" value="Go" /></div>
87+
<input type="text" name="q" />
88+
<input type="submit" value="Go" />
9789
<input type="hidden" name="check_keywords" value="yes" />
9890
<input type="hidden" name="area" value="default" />
9991
</form>
92+
</div>
10093
</div>
10194
<script type="text/javascript">$('#searchbox').show(0);</script>
10295
</div>
@@ -107,7 +100,7 @@ <h3>Quick search</h3>
107100
&copy;.
108101

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

113106
|

pandas/guide/genindex.html

+9-19
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,12 @@
55

66
<html xmlns="http://www.w3.org/1999/xhtml">
77
<head>
8+
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
89
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
910
<title>Index &#8212; Python documentation</title>
1011
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1112
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12-
<script type="text/javascript">
13-
var DOCUMENTATION_OPTIONS = {
14-
URL_ROOT: './',
15-
VERSION: '',
16-
COLLAPSE_INDEX: false,
17-
FILE_SUFFIX: '.html',
18-
HAS_SOURCE: true,
19-
SOURCELINK_SUFFIX: '.txt'
20-
};
21-
</script>
13+
<script type="text/javascript" src="_static/documentation_options.js"></script>
2214
<script type="text/javascript" src="_static/jquery.js"></script>
2315
<script type="text/javascript" src="_static/underscore.js"></script>
2416
<script type="text/javascript" src="_static/doctools.js"></script>
@@ -30,8 +22,7 @@
3022

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

33-
</head>
34-
<body>
25+
</head><body>
3526

3627

3728
<div class="document">
@@ -54,24 +45,23 @@ <h1 id="index">Index</h1>
5445
<div class="sphinxsidebarwrapper">
5546
<p class="logo"><a href="contents.html">
5647
<img class="logo" src="_static/logo.png" alt="Logo"/>
57-
</a></p>
58-
59-
<div class="relations">
48+
</a></p><div class="relations">
6049
<h3>Related Topics</h3>
6150
<ul>
6251
<li><a href="contents.html">Documentation overview</a><ul>
6352
</ul></li>
6453
</ul>
6554
</div>
66-
6755
<div id="searchbox" style="display: none" role="search">
6856
<h3>Quick search</h3>
57+
<div class="searchformwrapper">
6958
<form class="search" action="search.html" method="get">
70-
<div><input type="text" name="q" /></div>
71-
<div><input type="submit" value="Go" /></div>
59+
<input type="text" name="q" />
60+
<input type="submit" value="Go" />
7261
<input type="hidden" name="check_keywords" value="yes" />
7362
<input type="hidden" name="area" value="default" />
7463
</form>
64+
</div>
7565
</div>
7666
<script type="text/javascript">$('#searchbox').show(0);</script>
7767
</div>
@@ -82,7 +72,7 @@ <h3>Quick search</h3>
8272
&copy;.
8373

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

8878
</div>

0 commit comments

Comments
 (0)