Skip to content

Render protected Traversable methods in the reference#2192

Open
pick7 wants to merge 1 commit into
gitpython-developers:mainfrom
pick7:codex/document-protected-traversal
Open

Render protected Traversable methods in the reference#2192
pick7 wants to merge 1 commit into
gitpython-developers:mainfrom
pick7:codex/document-protected-traversal

Conversation

@pick7

@pick7 pick7 commented Jul 25, 2026

Copy link
Copy Markdown

Summary

  • Explicitly include Traversable's protected extension-interface methods in Sphinx autodoc output.
  • Render _get_intermediate_items, _list_traverse, and _traverse without exposing unrelated private members.

Addresses #1848.

Validation

  • LC_ALL=C LANG=C make SPHINXBUILD=.venv/bin/sphinx-build -C doc clean html
  • Verified all three members are present in doc/build/html/reference.html.
  • git diff --check

The local docs build completed successfully with existing Python 3.14 autodoc warnings.

AI agent disclosure

This pull request was prepared and submitted by OpenAI Codex acting as an AI agent through the contributor account.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

1 participant