Skip to content

Commit 8221ee9

Browse files
DOC: Adding header to the rst files that don't have it (#24191)
1 parent a771b47 commit 8221ee9

11 files changed

+17
-15
lines changed

Diff for: doc/source/api.rst

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
.. currentmodule:: pandas
21
.. _api:
32

3+
{{ header }}
4+
45
*************
56
API Reference
67
*************

Diff for: doc/source/contributing_docstring.rst

+2-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
.. _docstring:
22

3+
{{ header }}
4+
35
======================
46
pandas docstring guide
57
======================
68

7-
.. note::
8-
`Video tutorial: Pandas docstring guide
9-
<https://www.youtube.com/watch?v=EOA0lUeW4NI>`_ by Frank Akogun.
10-
119
About docstrings and standards
1210
------------------------------
1311

Diff for: doc/source/developer.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _developer:
22

3+
{{ header }}
4+
35
.. currentmodule:: pandas
46

57
*********

Diff for: doc/source/ecosystem.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _ecosystem:
22

3+
{{ header }}
4+
35
****************
46
pandas Ecosystem
57
****************

Diff for: doc/source/extending.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _extending:
22

3+
{{ header }}
4+
35
****************
46
Extending Pandas
57
****************

Diff for: doc/source/options.rst

+1-8
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
11
.. _options:
22

3-
.. currentmodule:: pandas
4-
5-
.. ipython:: python
6-
:suppress:
7-
8-
import pandas as pd
9-
import numpy as np
10-
np.random.seed(123456)
3+
{{ header }}
114

125
********************
136
Options and Settings

Diff for: doc/source/overview.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
.. _overview:
22

3-
.. currentmodule:: pandas
3+
{{ header }}
44

55
****************
66
Package overview

Diff for: doc/source/r_interface.rst

-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22

33
{{ header }}
44

5-
65
******************
76
rpy2 / R interface
87
******************

Diff for: doc/source/releases.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _release:
22

3+
{{ header }}
4+
35
*************
46
Release Notes
57
*************

Diff for: doc/source/tutorials.rst

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
.. _tutorials:
22

3+
{{ header }}
4+
35
*********
46
Tutorials
57
*********

Diff for: scripts/validate_docstrings.py

+1
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,7 @@ def get_api_items(api_doc_fd):
174174
The name of the subsection in the API page where the object item is
175175
located.
176176
"""
177+
current_module = 'pandas'
177178
previous_line = current_section = current_subsection = ''
178179
position = None
179180
for line in api_doc_fd:

0 commit comments

Comments
 (0)