Skip to content

Commit e08facc

Browse files
datapythonistadatapythonista
committed
Adding standard for documenting an axis parameter
1 parent 2164c75 commit e08facc

File tree

14 files changed

+240
-189
lines changed

14 files changed

+240
-189
lines changed

‎pandas/guide/_sources/pandas_docstring.rst.txt‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -399,6 +399,10 @@ last two types, that need to be separated by the word 'or':
399399
If ``None`` is one of the accepted values, it always needs to be the last in
400400
the list.
401401

402+
For axis, the convention is to use something like:
403+
404+
- axis : {0 or 'index', 1 or 'columns', None}, default None
405+
402406
.. _docstring.returns:
403407

404408
Section 4: Returns or Yields

‎pandas/guide/_static/basic.css‎

Lines changed: 1 addition & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -82,21 +82,9 @@ div.sphinxsidebar input {
8282
}
8383

8484
div.sphinxsidebar #searchbox input[type="text"] {
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;
85+
width: 170px;
9786
}
9887

99-
10088
img {
10189
border: 0;
10290
max-width: 100%;
@@ -211,11 +199,6 @@ table.modindextable td {
211199

212200
/* -- general body styles --------------------------------------------------- */
213201

214-
div.body {
215-
min-width: 450px;
216-
max-width: 800px;
217-
}
218-
219202
div.body p, div.body dd, div.body li, div.body blockquote {
220203
-moz-hyphens: auto;
221204
-ms-hyphens: auto;
@@ -349,11 +332,6 @@ table.docutils {
349332
border-collapse: collapse;
350333
}
351334

352-
table.align-center {
353-
margin-left: auto;
354-
margin-right: auto;
355-
}
356-
357335
table caption span.caption-number {
358336
font-style: italic;
359337
}

‎pandas/guide/_static/jquery.js‎

Lines changed: 4 additions & 4 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pandas/guide/_static/websupport.js‎

Lines changed: 1 addition & 1 deletion
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(var i=0; i < siblings.length; i++) {
304+
for(i=0; i < siblings.length; i++) {
305305
if (comp(comment, siblings[i]) <= 0) {
306306
$('#cd' + siblings[i].id)
307307
.parent()

‎pandas/guide/genindex.html‎

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,20 @@
55

66
<html xmlns="http://www.w3.org/1999/xhtml">
77
<head>
8-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
98
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
109
<title>Index &#8212; Python documentation</title>
1110
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1211
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
13-
<script type="text/javascript" src="_static/documentation_options.js"></script>
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>
1422
<script type="text/javascript" src="_static/jquery.js"></script>
1523
<script type="text/javascript" src="_static/underscore.js"></script>
1624
<script type="text/javascript" src="_static/doctools.js"></script>
@@ -22,7 +30,8 @@
2230

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

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

2736

2837
<div class="document">
@@ -45,23 +54,24 @@ <h1 id="index">Index</h1>
4554
<div class="sphinxsidebarwrapper">
4655
<p class="logo"><a href="index.html">
4756
<img class="logo" src="_static/logo.png" alt="Logo"/>
48-
</a></p><div class="relations">
57+
</a></p>
58+
59+
<div class="relations">
4960
<h3>Related Topics</h3>
5061
<ul>
5162
<li><a href="index.html">Documentation overview</a><ul>
5263
</ul></li>
5364
</ul>
5465
</div>
66+
5567
<div id="searchbox" style="display: none" role="search">
5668
<h3>Quick search</h3>
57-
<div class="searchformwrapper">
5869
<form class="search" action="search.html" method="get">
59-
<input type="text" name="q" />
60-
<input type="submit" value="Go" />
70+
<div><input type="text" name="q" /></div>
71+
<div><input type="submit" value="Go" /></div>
6172
<input type="hidden" name="check_keywords" value="yes" />
6273
<input type="hidden" name="area" value="default" />
6374
</form>
64-
</div>
6575
</div>
6676
<script type="text/javascript">$('#searchbox').show(0);</script>
6777
</div>
@@ -72,7 +82,7 @@ <h3>Quick search</h3>
7282
&copy;.
7383

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

7888
</div>

‎pandas/guide/index.html‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44

55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
87
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
98
<title>Pandas documentation sprint &#8212; Python documentation</title>
109
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1110
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12-
<script type="text/javascript" src="_static/documentation_options.js"></script>
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>
1321
<script type="text/javascript" src="_static/jquery.js"></script>
1422
<script type="text/javascript" src="_static/underscore.js"></script>
1523
<script type="text/javascript" src="_static/doctools.js"></script>
@@ -22,7 +30,8 @@
2230

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

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

2736

2837
<div class="document">
@@ -83,14 +92,12 @@ <h3>This Page</h3>
8392
</div>
8493
<div id="searchbox" style="display: none" role="search">
8594
<h3>Quick search</h3>
86-
<div class="searchformwrapper">
8795
<form class="search" action="search.html" method="get">
88-
<input type="text" name="q" />
89-
<input type="submit" value="Go" />
96+
<div><input type="text" name="q" /></div>
97+
<div><input type="submit" value="Go" /></div>
9098
<input type="hidden" name="check_keywords" value="yes" />
9199
<input type="hidden" name="area" value="default" />
92100
</form>
93-
</div>
94101
</div>
95102
<script type="text/javascript">$('#searchbox').show(0);</script>
96103
</div>
@@ -101,7 +108,7 @@ <h3>Quick search</h3>
101108
&copy;.
102109

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

107114
|

‎pandas/guide/organizers.html‎

Lines changed: 15 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,20 @@
44

55
<html xmlns="http://www.w3.org/1999/xhtml">
66
<head>
7-
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
87
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
98
<title>Information for organizers &#8212; Python documentation</title>
109
<link rel="stylesheet" href="_static/alabaster.css" type="text/css" />
1110
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
12-
<script type="text/javascript" src="_static/documentation_options.js"></script>
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>
1321
<script type="text/javascript" src="_static/jquery.js"></script>
1422
<script type="text/javascript" src="_static/underscore.js"></script>
1523
<script type="text/javascript" src="_static/doctools.js"></script>
@@ -21,7 +29,8 @@
2129

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

24-
</head><body>
32+
</head>
33+
<body>
2534

2635

2736
<div class="document">
@@ -264,14 +273,12 @@ <h3>This Page</h3>
264273
</div>
265274
<div id="searchbox" style="display: none" role="search">
266275
<h3>Quick search</h3>
267-
<div class="searchformwrapper">
268276
<form class="search" action="search.html" method="get">
269-
<input type="text" name="q" />
270-
<input type="submit" value="Go" />
277+
<div><input type="text" name="q" /></div>
278+
<div><input type="submit" value="Go" /></div>
271279
<input type="hidden" name="check_keywords" value="yes" />
272280
<input type="hidden" name="area" value="default" />
273281
</form>
274-
</div>
275282
</div>
276283
<script type="text/javascript">$('#searchbox').show(0);</script>
277284
</div>
@@ -282,7 +289,7 @@ <h3>Quick search</h3>
282289
&copy;.
283290

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

288295
|

0 commit comments

Comments
 (0)