diff --git a/doc/source/development/community.rst b/doc/source/development/community.rst index ab8294b8f135a..1c698d130ea6c 100644 --- a/doc/source/development/community.rst +++ b/doc/source/development/community.rst @@ -77,7 +77,7 @@ Any community member can open issues to: - Ask questions, e.g. "I noticed the behavior of a certain function changed between versions. Is this expected?". - Ideally, your questions should be related to how pandas works rather + - Ideally, your questions should be related to how pandas works rather than how you use pandas. `StackOverflow `_ is better suited for answering usage questions, and we ask that all usage questions are first asked on StackOverflow. Thank you for respecting our diff --git a/doc/source/development/contributing.rst b/doc/source/development/contributing.rst index 4d99f282aa695..66178a88e3e31 100644 --- a/doc/source/development/contributing.rst +++ b/doc/source/development/contributing.rst @@ -234,14 +234,14 @@ and merged into project to appear the in the next release. To submit a pull requ #. Write a descriptive title that includes prefixes. pandas uses a convention for title prefixes. Here are some common ones along with general guidelines for when to use them: - * ENH: Enhancement, new functionality - * BUG: Bug fix - * DOC: Additions/updates to documentation - * TST: Additions/updates to tests - * BLD: Updates to the build process/scripts - * PERF: Performance improvement - * TYP: Type annotations - * CLN: Code cleanup + * ENH: Enhancement, new functionality + * BUG: Bug fix + * DOC: Additions/updates to documentation + * TST: Additions/updates to tests + * BLD: Updates to the build process/scripts + * PERF: Performance improvement + * TYP: Type annotations + * CLN: Code cleanup #. Write a description of your changes in the ``Preview Discussion`` tab #. Click ``Send Pull Request``. diff --git a/doc/source/development/contributing_codebase.rst b/doc/source/development/contributing_codebase.rst index b8d568428c156..73bc756de9302 100644 --- a/doc/source/development/contributing_codebase.rst +++ b/doc/source/development/contributing_codebase.rst @@ -444,11 +444,11 @@ be located. result = ser.loc[[3, 4]] tm.assert_series_equal(result, expected) - In cases like this, the test location should be based on the *underlying* - method being tested. Or in the case of a test for a bugfix, the location - of the actual bug. So in this example, we know that ``Series.__getitem__`` - calls ``Series.loc.__getitem__``, so this is *really* a test for - ``loc.__getitem__``. So this test belongs in ``tests.indexing.test_loc``. + In cases like this, the test location should be based on the *underlying* + method being tested. Or in the case of a test for a bugfix, the location + of the actual bug. So in this example, we know that ``Series.__getitem__`` + calls ``Series.loc.__getitem__``, so this is *really* a test for + ``loc.__getitem__``. So this test belongs in ``tests.indexing.test_loc``. 6. Is your test for a DataFrame or Series method? diff --git a/doc/source/development/contributing_gitpod.rst b/doc/source/development/contributing_gitpod.rst index b70981b4d307d..447b7b20a8ae5 100644 --- a/doc/source/development/contributing_gitpod.rst +++ b/doc/source/development/contributing_gitpod.rst @@ -158,8 +158,8 @@ Option 1: using Liveserve file and click on **Open with Live Serve**. Alternatively, you can open the file in the editor and click on the **Go live** button on the status bar. - .. image:: ./gitpod-imgs/vscode-statusbar.png - :alt: Gitpod workspace VSCode start live serve screenshot + .. image:: ./gitpod-imgs/vscode-statusbar.png + :alt: Gitpod workspace VSCode start live serve screenshot #. A simple browser will open to the right-hand side of the editor. We recommend closing it and click on the **Open in browser** button in the pop-up. @@ -182,13 +182,13 @@ uses the rst extension with docutils. :kbd:`Ctrl-Shift-P` in Linux and Windows. Start typing "restructured" and choose either "Open preview" or "Open preview to the Side". - .. image:: ./gitpod-imgs/vscode-rst.png - :alt: Gitpod workspace VSCode open rst screenshot + .. image:: ./gitpod-imgs/vscode-rst.png + :alt: Gitpod workspace VSCode open rst screenshot #. As you work on the document, you will see a live rendering of it on the editor. - .. image:: ./gitpod-imgs/rst-rendering.png - :alt: Gitpod workspace VSCode rst rendering screenshot + .. image:: ./gitpod-imgs/rst-rendering.png + :alt: Gitpod workspace VSCode rst rendering screenshot If you want to see the final output with the ``html`` theme you will need to rebuild the docs with ``make html`` and use Live Serve as described in option 1. diff --git a/doc/source/development/debugging_extensions.rst b/doc/source/development/debugging_extensions.rst index 3b955e7bbb0a5..c8127e0cc2996 100644 --- a/doc/source/development/debugging_extensions.rst +++ b/doc/source/development/debugging_extensions.rst @@ -10,9 +10,9 @@ pandas uses Cython and C/C++ `extension modules `_ - 2. `Fundamental Python Debugging Part 2 - Python Extensions `_ - 3. `Fundamental Python Debugging Part 3 - Cython Extensions `_ +1. `Fundamental Python Debugging Part 1 - Python `_ +2. `Fundamental Python Debugging Part 2 - Python Extensions `_ +3. `Fundamental Python Debugging Part 3 - Cython Extensions `_ Debugging locally ----------------- diff --git a/doc/source/development/developer.rst b/doc/source/development/developer.rst index c5c4b7c449ce7..21a840fbe9a5f 100644 --- a/doc/source/development/developer.rst +++ b/doc/source/development/developer.rst @@ -116,19 +116,19 @@ The ``metadata`` field is ``None`` except for: omitted it is assumed to be nanoseconds. * ``categorical``: ``{'num_categories': K, 'ordered': is_ordered, 'type': $TYPE}`` - * Here ``'type'`` is optional, and can be a nested pandas type specification - here (but not categorical) + * Here ``'type'`` is optional, and can be a nested pandas type specification + here (but not categorical) * ``unicode``: ``{'encoding': encoding}`` - * The encoding is optional, and if not present is UTF-8 + * The encoding is optional, and if not present is UTF-8 * ``object``: ``{'encoding': encoding}``. Objects can be serialized and stored in ``BYTE_ARRAY`` Parquet columns. The encoding can be one of: - * ``'pickle'`` - * ``'bson'`` - * ``'json'`` + * ``'pickle'`` + * ``'bson'`` + * ``'json'`` * ``timedelta``: ``{'unit': 'ns'}``. The ``'unit'`` is optional, and if omitted it is assumed to be nanoseconds. This metadata is optional altogether diff --git a/doc/source/development/maintaining.rst b/doc/source/development/maintaining.rst index c572559dcc3e0..c37925f7e271a 100644 --- a/doc/source/development/maintaining.rst +++ b/doc/source/development/maintaining.rst @@ -218,11 +218,11 @@ pandas supports point releases (e.g. ``1.4.3``) that aim to: 1. Fix bugs in new features introduced in the first minor version release. - * e.g. If a new feature was added in ``1.4`` and contains a bug, a fix can be applied in ``1.4.3`` + * e.g. If a new feature was added in ``1.4`` and contains a bug, a fix can be applied in ``1.4.3`` 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. - * e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``. + * e.g. If a feature worked in ``1.2`` and stopped working since ``1.3``, a fix can be applied in ``1.4.3``. Since pandas minor releases are based on GitHub branches (e.g. point release of ``1.4`` are based off the ``1.4.x`` branch), "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: 1. Contact the contributor and ask their interest to join. 2. Add the contributor to the appropriate `GitHub Team `_ if accepted the invitation. - * ``pandas-core`` is for core team members - * ``pandas-triage`` is for pandas triage members + * ``pandas-core`` is for core team members + * ``pandas-triage`` is for pandas triage members If adding to ``pandas-core``, there are two additional steps: @@ -467,10 +467,10 @@ Post-Release patch releases. The exact instructions are (replace the example version numbers by the appropriate ones for the version you are releasing): - - Log in to the server and use the correct user. - - ``cd /var/www/html/pandas-docs/`` - - ``ln -sfn version/2.1 stable`` (for a major or minor release) - - ``ln -sfn version/2.0.3 version/2.0`` (for a patch release) + - Log in to the server and use the correct user. + - ``cd /var/www/html/pandas-docs/`` + - ``ln -sfn version/2.1 stable`` (for a major or minor release) + - ``ln -sfn version/2.0.3 version/2.0`` (for a patch release) 2. If releasing a major or minor release, open a PR in our source code to update ``web/pandas/versions.json``, to have the desired versions in the documentation @@ -487,8 +487,8 @@ Post-Release 6. Announce the new release in the official channels (use previous announcements for reference): - - The pandas-dev and pydata mailing lists - - X, Mastodon, Telegram and LinkedIn + - The pandas-dev and pydata mailing lists + - X, Mastodon, Telegram and LinkedIn 7. Update this release instructions to fix anything incorrect and to update about any change since the last release.