Skip to content

Sync profile docs with implementation#2495

Merged
DanielNoord merged 3 commits intomainfrom
copilot/fix-docs-profiles-sync-issue
Mar 14, 2026
Merged

Sync profile docs with implementation#2495
DanielNoord merged 3 commits intomainfrom
copilot/fix-docs-profiles-sync-issue

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 14, 2026

The docs/configuration/profiles.md had drifted from the actual profile definitions in isort/profiles.py.

What changed in the docs

  • Google: Was missing line_length: 1000 and had a truncated single_line_exclusions: ('typing',) instead of the full ('collections.abc', 'six.moves', 'typing', 'typing_extensions')
  • Appnexus: Was missing split_on_trailing_comma: True (inherited from black via **black unpacking)
  • Plone: Retains the original hand-crafted "Based on black with these tweaks:" description listing only the 2 plone-specific settings (force_alphabetical_sort and force_single_line)
  • Black: No change — split_on_trailing_comma: True was already present in the implementation
Original prompt

This section details on the original issue you should resolve

<issue_title>Docs about profiles not in sync with implementation</issue_title>
<issue_description>There are two cases where the docs about profiles don't agree with the implementation.

Black profile: the docs say that the profile should set split_on_trailing_comma=True while the implementation incorrectly doesn't set this option.

Plone profile: The docs are outdated.</issue_description>

Comments on the Issue (you are @copilot in this section)


📍 Connect Copilot coding agent with Jira, Azure Boards or Linear to delegate work to Copilot in one click without leaving your project management tool.

Co-authored-by: DanielNoord <13665637+DanielNoord@users.noreply.github.com>
Copilot AI changed the title [WIP] Fix docs about profiles not in sync with implementation Sync profile docs with implementation via build_profile_docs.py Mar 14, 2026
Copilot AI requested a review from DanielNoord March 14, 2026 20:53
Comment on lines 55 to 65

Based on black with these tweaks:

- **multi_line_output**: `3`
- **include_trailing_comma**: `True`
- **split_on_trailing_comma**: `True`
- **force_grid_wrap**: `0`
- **use_parentheses**: `True`
- **ensure_newline_before_comments**: `True`
- **line_length**: `88`
- **force_alphabetical_sort**: `True`
- **force_single_line**: `True`
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@copilot Revert the changes in these lines

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done in c9f6cea — the plone section is reverted to the original "Based on black with these tweaks:" description showing only the 2 plone-specific settings.

Co-authored-by: DanielNoord <13665637+DanielNoord@users.noreply.github.com>
@DanielNoord DanielNoord marked this pull request as ready for review March 14, 2026 20:57
Copilot AI changed the title Sync profile docs with implementation via build_profile_docs.py Sync profile docs with implementation Mar 14, 2026
Copilot AI requested a review from DanielNoord March 14, 2026 20:57
@DanielNoord DanielNoord enabled auto-merge March 14, 2026 20:57
@codecov
Copy link
Copy Markdown

codecov bot commented Mar 14, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 99.16%. Comparing base (87439d5) to head (c9f6cea).
⚠️ Report is 4 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2495   +/-   ##
=======================================
  Coverage   99.16%   99.16%           
=======================================
  Files          40       40           
  Lines        3096     3096           
  Branches      674      674           
=======================================
  Hits         3070     3070           
  Misses         14       14           
  Partials       12       12           
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@DanielNoord DanielNoord added this pull request to the merge queue Mar 14, 2026
Merged via the queue into main with commit 214e4cb Mar 14, 2026
23 checks passed
@DanielNoord DanielNoord deleted the copilot/fix-docs-profiles-sync-issue branch March 14, 2026 21:01
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.

Docs about profiles not in sync with implementation

2 participants