Skip to content

DOC: explain custom attribute combination policies - #11795

Open
ZFzuofeng wants to merge 1 commit into
pydata:mainfrom
ZFzuofeng:docs/combine-attrs-guide
Open

ZFzuofeng wants to merge 1 commit into
pydata:mainfrom
ZFzuofeng:docs/combine-attrs-guide

Conversation

@ZFzuofeng

Copy link
Copy Markdown

Description

Document existing attribute-combination behavior without changing runtime behavior. The example combines source-name lists without modifying the inputs, and gives consistent results when combination happens in stages. Also clarify that compat="identical" checks attributes even with combine_attrs="drop".

Related to #6679.

Validation

  • Related merge/concat/combine tests: 355 passed, 1 existing xfailed.
  • Executed the affected guide in a real Jupyter kernel: 30 cells, including one explicitly expected MergeError.
  • Isolated Sphinx build with warnings treated as errors, rendered example/navigation/API-link checks, Prettier, blackdoc, and git diff --check passed.
  • The final prose-only clarification was rechecked through execution, rendering, links, and formatting; the unchanged related tests were not repeated afterward.

The example handles source names stored as lists of strings; it is not a general attribute-merging policy. The full documentation site, full test suite, and complete pre-commit suite were not run locally.

Checklist

  • Documentation example executed and checked.

AI Disclosure

  • This PR contains AI-generated content.
    • I have tested any AI-generated content in my PR.
    • I take responsibility for any AI-generated content in my PR. Tools: OpenAI Codex, used to review and verify the supplied candidate, revise the documentation, and translate the submitter's Chinese explanation.
      Prompt scope: review the supplied contribution candidates, explain their changes and limitations, and submit after human review.

The human submitter reviewed the changes and stated, in Chinese, that this documents existing behavior, accepts the described limitations, and takes responsibility for the contribution. The explanation above translates that reviewed rationale; validation results are recorded from the local runs.

[This is OpenAI Codex submitting on behalf of @ZFzuofeng, after their review and explicit authorization.]

Document combine_attrs across combining APIs, including callable examples,
attribute scopes, staged invocation, and interaction with compat.

Co-authored-by: OpenAI Codex <noreply@openai.com>

This branch has not been deployed

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant