Skip to content

Commit 0238efa

Browse files
authored
Fix some incorrect indents in development documentation (#61664)
1 parent 5909621 commit 0238efa

File tree

7 files changed

+39
-39
lines changed

7 files changed

+39
-39
lines changed

doc/source/development/community.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Any community member can open issues to:
7777
- Ask questions, e.g. "I noticed the behavior of a certain function
7878
changed between versions. Is this expected?".
7979

80-
Ideally, your questions should be related to how pandas works rather
80+
- Ideally, your questions should be related to how pandas works rather
8181
than how you use pandas. `StackOverflow <https://stackoverflow.com/>`_ is
8282
better suited for answering usage questions, and we ask that all usage
8383
questions are first asked on StackOverflow. Thank you for respecting our

doc/source/development/contributing.rst

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -234,14 +234,14 @@ and merged into project to appear the in the next release. To submit a pull requ
234234
#. Write a descriptive title that includes prefixes. pandas uses a convention for title
235235
prefixes. Here are some common ones along with general guidelines for when to use them:
236236

237-
* ENH: Enhancement, new functionality
238-
* BUG: Bug fix
239-
* DOC: Additions/updates to documentation
240-
* TST: Additions/updates to tests
241-
* BLD: Updates to the build process/scripts
242-
* PERF: Performance improvement
243-
* TYP: Type annotations
244-
* CLN: Code cleanup
237+
* ENH: Enhancement, new functionality
238+
* BUG: Bug fix
239+
* DOC: Additions/updates to documentation
240+
* TST: Additions/updates to tests
241+
* BLD: Updates to the build process/scripts
242+
* PERF: Performance improvement
243+
* TYP: Type annotations
244+
* CLN: Code cleanup
245245

246246
#. Write a description of your changes in the ``Preview Discussion`` tab
247247
#. Click ``Send Pull Request``.

doc/source/development/contributing_codebase.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -444,11 +444,11 @@ be located.
444444
result = ser.loc[[3, 4]]
445445
tm.assert_series_equal(result, expected)
446446
447-
In cases like this, the test location should be based on the *underlying*
448-
method being tested. Or in the case of a test for a bugfix, the location
449-
of the actual bug. So in this example, we know that ``Series.__getitem__``
450-
calls ``Series.loc.__getitem__``, so this is *really* a test for
451-
``loc.__getitem__``. So this test belongs in ``tests.indexing.test_loc``.
447+
In cases like this, the test location should be based on the *underlying*
448+
method being tested. Or in the case of a test for a bugfix, the location
449+
of the actual bug. So in this example, we know that ``Series.__getitem__``
450+
calls ``Series.loc.__getitem__``, so this is *really* a test for
451+
``loc.__getitem__``. So this test belongs in ``tests.indexing.test_loc``.
452452

453453
6. Is your test for a DataFrame or Series method?
454454

doc/source/development/contributing_gitpod.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ Option 1: using Liveserve
158158
file and click on **Open with Live Serve**. Alternatively, you can open the
159159
file in the editor and click on the **Go live** button on the status bar.
160160

161-
.. image:: ./gitpod-imgs/vscode-statusbar.png
162-
:alt: Gitpod workspace VSCode start live serve screenshot
161+
.. image:: ./gitpod-imgs/vscode-statusbar.png
162+
:alt: Gitpod workspace VSCode start live serve screenshot
163163

164164
#. A simple browser will open to the right-hand side of the editor. We recommend
165165
closing it and click on the **Open in browser** button in the pop-up.
@@ -182,13 +182,13 @@ uses the rst extension with docutils.
182182
:kbd:`Ctrl-Shift-P` in Linux and Windows. Start typing "restructured"
183183
and choose either "Open preview" or "Open preview to the Side".
184184

185-
.. image:: ./gitpod-imgs/vscode-rst.png
186-
:alt: Gitpod workspace VSCode open rst screenshot
185+
.. image:: ./gitpod-imgs/vscode-rst.png
186+
:alt: Gitpod workspace VSCode open rst screenshot
187187

188188
#. As you work on the document, you will see a live rendering of it on the editor.
189189

190-
.. image:: ./gitpod-imgs/rst-rendering.png
191-
:alt: Gitpod workspace VSCode rst rendering screenshot
190+
.. image:: ./gitpod-imgs/rst-rendering.png
191+
:alt: Gitpod workspace VSCode rst rendering screenshot
192192

193193
If you want to see the final output with the ``html`` theme you will need to
194194
rebuild the docs with ``make html`` and use Live Serve as described in option 1.

doc/source/development/debugging_extensions.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ pandas uses Cython and C/C++ `extension modules <https://docs.python.org/3/exten
1010

1111
For Python developers with limited or no C/C++ experience this can seem a daunting task. Core developer Will Ayd has written a 3 part blog series to help guide you from the standard Python debugger into these other tools:
1212

13-
1. `Fundamental Python Debugging Part 1 - Python <https://willayd.com/fundamental-python-debugging-part-1-python.html>`_
14-
2. `Fundamental Python Debugging Part 2 - Python Extensions <https://willayd.com/fundamental-python-debugging-part-2-python-extensions.html>`_
15-
3. `Fundamental Python Debugging Part 3 - Cython Extensions <https://willayd.com/fundamental-python-debugging-part-3-cython-extensions.html>`_
13+
1. `Fundamental Python Debugging Part 1 - Python <https://willayd.com/fundamental-python-debugging-part-1-python.html>`_
14+
2. `Fundamental Python Debugging Part 2 - Python Extensions <https://willayd.com/fundamental-python-debugging-part-2-python-extensions.html>`_
15+
3. `Fundamental Python Debugging Part 3 - Cython Extensions <https://willayd.com/fundamental-python-debugging-part-3-cython-extensions.html>`_
1616

1717
Debugging locally
1818
-----------------

doc/source/development/developer.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -116,19 +116,19 @@ The ``metadata`` field is ``None`` except for:
116116
omitted it is assumed to be nanoseconds.
117117
* ``categorical``: ``{'num_categories': K, 'ordered': is_ordered, 'type': $TYPE}``
118118

119-
* Here ``'type'`` is optional, and can be a nested pandas type specification
120-
here (but not categorical)
119+
* Here ``'type'`` is optional, and can be a nested pandas type specification
120+
here (but not categorical)
121121

122122
* ``unicode``: ``{'encoding': encoding}``
123123

124-
* The encoding is optional, and if not present is UTF-8
124+
* The encoding is optional, and if not present is UTF-8
125125

126126
* ``object``: ``{'encoding': encoding}``. Objects can be serialized and stored
127127
in ``BYTE_ARRAY`` Parquet columns. The encoding can be one of:
128128

129-
* ``'pickle'``
130-
* ``'bson'``
131-
* ``'json'``
129+
* ``'pickle'``
130+
* ``'bson'``
131+
* ``'json'``
132132

133133
* ``timedelta``: ``{'unit': 'ns'}``. The ``'unit'`` is optional, and if omitted
134134
it is assumed to be nanoseconds. This metadata is optional altogether

doc/source/development/maintaining.rst

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -218,11 +218,11 @@ pandas supports point releases (e.g. ``1.4.3``) that aim to:
218218

219219
1. Fix bugs in new features introduced in the first minor version release.
220220

221-
* e.g. If a new feature was added in ``1.4`` and contains a bug, a fix can be applied in ``1.4.3``
221+
* e.g. If a new feature was added in ``1.4`` and contains a bug, a fix can be applied in ``1.4.3``
222222

223223
2. Fix bugs that used to work in a few minor releases prior. There should be agreement between core team members that a backport is appropriate.
224224

225-
* e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``.
225+
* e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``.
226226

227227
Since pandas minor releases are based on GitHub branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch),
228228
"backporting" means merging a pull request fix to the ``main`` branch and correct minor branch associated with the next point release.
@@ -289,8 +289,8 @@ The required steps for adding a maintainer are:
289289
1. Contact the contributor and ask their interest to join.
290290
2. Add the contributor to the appropriate `GitHub Team <https://github.com/orgs/pandas-dev/teams>`_ if accepted the invitation.
291291

292-
* ``pandas-core`` is for core team members
293-
* ``pandas-triage`` is for pandas triage members
292+
* ``pandas-core`` is for core team members
293+
* ``pandas-triage`` is for pandas triage members
294294

295295
If adding to ``pandas-core``, there are two additional steps:
296296

@@ -467,10 +467,10 @@ Post-Release
467467
patch releases. The exact instructions are (replace the example version numbers by
468468
the appropriate ones for the version you are releasing):
469469

470-
- Log in to the server and use the correct user.
471-
- ``cd /var/www/html/pandas-docs/``
472-
- ``ln -sfn version/2.1 stable`` (for a major or minor release)
473-
- ``ln -sfn version/2.0.3 version/2.0`` (for a patch release)
470+
- Log in to the server and use the correct user.
471+
- ``cd /var/www/html/pandas-docs/``
472+
- ``ln -sfn version/2.1 stable`` (for a major or minor release)
473+
- ``ln -sfn version/2.0.3 version/2.0`` (for a patch release)
474474

475475
2. If releasing a major or minor release, open a PR in our source code to update
476476
``web/pandas/versions.json``, to have the desired versions in the documentation
@@ -487,8 +487,8 @@ Post-Release
487487
6. Announce the new release in the official channels (use previous announcements
488488
for reference):
489489

490-
- The pandas-dev and pydata mailing lists
491-
- X, Mastodon, Telegram and LinkedIn
490+
- The pandas-dev and pydata mailing lists
491+
- X, Mastodon, Telegram and LinkedIn
492492

493493
7. Update this release instructions to fix anything incorrect and to update about any
494494
change since the last release.

0 commit comments

Comments
 (0)