Skip to content

Conversation

Sayeem3051
Copy link
Contributor

This PR addresses issue #61511 by updating the debugging_extensions.rst documentation.

Summary of Changes

  • Removed the outdated "Using Docker" section as the Docker image is out of date
  • Added a new "Using cygdb for Cython debugging" section emphasizing local installations
  • Documented that cygdb comes pre-installed with Cython
  • Updated to reflect preference for local installations as discussed in the issue

As mentioned by @WillAyd in the issue discussion, the pandas team gets very little usage of the docker containers, so this change removes that documentation and focuses on the preferred local debugging approach using cygdb.

Closes

Checklist

  • This is a documentation-only change

  • No tests needed (documentation change only)

  • No type annotations needed (documentation change only)

  • No whatsnew entry needed (documentation improvement)…nsDOC: Remove outdated Docker image from debugging_extensions documentationDOC: Remove outdated Docker image from debugging_extensions documentationUpdate debugging_extensions.rst

  • Removed the 'Using Docker' section as the Docker image is out of date

  • Added 'Using cygdb for Cython debugging' section emphasizing local installations

  • Documented that cygdb comes pre-installed with Cython

  • Updated to reflect preference for local installations as discussed in issue

Closes #61511

  • closes #xxxx (Replace xxxx with the GitHub issue number)
  • Tests added and passed if fixing a bug or adding a new feature
  • All code checks passed.
  • Added type annotations to new arguments/methods/functions.
  • Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.

…nsDOC: Remove outdated Docker image from debugging_extensions documentationDOC: Remove outdated Docker image from debugging_extensions documentationUpdate debugging_extensions.rst

- Removed the 'Using Docker' section as the Docker image is out of date
- Added 'Using cygdb for Cython debugging' section emphasizing local installations
- Documented that cygdb comes pre-installed with Cython
- Updated to reflect preference for local installations as discussed in issue

Closes pandas-dev#61511
@Sayeem3051 Sayeem3051 changed the title DOC: Remove outdated Docker section, add cygdb instructions (#61511)DOC: Remove outdated Docker image, add local cygdb instructionsDOC: Remove outdated Docker image section, add local cygdb instructio… Remove outdated Docker image section, add local cygdb instruction Sep 20, 2025
---------------------------------

python -m pip install -ve . --no-build-isolation -Cbuilddir="debug" -Csetup-args="-Dbuildtype=debug"
For debugging Cython extensions, ``cygdb`` is the recommended approach. The ``cygdb`` debugger comes pre-installed with Cython, so if you have Cython installed in your development environment, you should already have access to it.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah cool - so cygdb works out of the box now? I vaguely recall it requiring a gcc and/or python built with particular flags, but if that is not necessary anymore that makes things much easier

@Sayeem3051
Copy link
Contributor Author

Thanks for the question @WillAyd! Yes, cygdb does work out of the box now for most users. If you have Cython installed, cygdb is available without needing special build flags for Python or gcc.

There might be some edge cases where debug symbols or certain compiler options (like disabling optimization with -O0) could be needed, but for pandas development, cygdb typically just works as long as you've built pandas in debug mode as shown in the docs.

If any issues do arise, users can check for debug symbols and compiler flags, but the standard debug build should be sufficient for most debugging scenarios.

Thanks for your input on this! Let me know if you have any feedback or corrections.

@mroeschke mroeschke requested a review from WillAyd September 22, 2025 16:58
@WillAyd WillAyd merged commit dab2f73 into pandas-dev:main Sep 22, 2025
8 checks passed
@WillAyd
Copy link
Member

WillAyd commented Sep 22, 2025

Great thanks @Sayeem3051 !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: Docker image provided on "Debugging C extensions" is out of date
2 participants