Skip to content

Python: fix(core): ensure proper section spacing and argument grouping in build_layered_docstring - #8691

Closed
Manohar Paturi (ManoharPaturi) wants to merge 1 commit into
microsoft:mainfrom
ManoharPaturi:fix/layered-docstring-spacing
Closed

Manohar Paturi (ManoharPaturi) wants to merge 1 commit into
microsoft:mainfrom
ManoharPaturi:fix/layered-docstring-spacing

Conversation

@ManoharPaturi

Copy link
Copy Markdown
Contributor

When inspecting docstrings generated by build_layered_docstring, I noticed two formatting inconsistencies with section separation:

First, when appending extra keyword arguments to an existing Keyword Args section, the new lines were inserted after the section trailing blank line instead of before it. This created an extra blank line in the middle of the Keyword Args list while removing the blank line before the subsequent section like Returns.

Second, when injecting a new Keyword Args section into a docstring that already had an Args section, an extra blank line was inserted preceding the Keyword Args header, producing multiple consecutive blank lines.

This PR updates build_layered_docstring so that new keyword arguments are appended directly to the end of the existing list before any trailing blank line, and newly created sections maintain standard single blank line separation from neighboring sections, matching the pattern in insert_docstring_block. I also updated test_docstrings.py with adjacency and spacing assertions.

…ld_layered_docstring

Signed-off-by: Manohar Paturi <186662190+ManoharPaturi@users.noreply.github.com>

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@agent-framework-automation agent-framework-automation Bot added the python Usage: [Issues, PRs], Target: Python label Sep 23, 2026
@github-actions github-actions Bot changed the title fix(core): ensure proper section spacing and argument grouping in build_layered_docstring Python: fix(core): ensure proper section spacing and argument grouping in build_layered_docstring Sep 23, 2026
@eavanvalkenburg

Copy link
Copy Markdown
Member

Thank you for proposing this change. I am closing this PR for now because it has no linked issue, and I could not find an issue covering this specific problem. Our contribution guidelines ask contributors to create or reuse an issue and discuss the approach before nontrivial changes (with an exception for trivial changes). The repository PR template asks for Motivation & Context, Description & Review Guide, a Related Issue linked with a closing keyword such as Fixes #123, and the contribution checklist; it notes that PRs without an issue link may be closed. This description does not follow that template. Please open or identify an issue, agree on the approach with the maintainers, then submit an updated PR using the template and linking the issue. Thanks.

This branch was previously deployed

1 inactive deployment
github-app-auth — abc57718 Deployed Sep 23, 2026 by ManoharPaturi via team_check #5162
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

python Usage: [Issues, PRs], Target: Python

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants