You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Three changes to docs/conf.py: (1) removes the app.setup_extension("sphinxcontrib.jquery") call from setup(), (2) reflows html_sidebars onto multiple lines, (3) reflows the extlinks dict onto multiple lines. Docs-only, no functional code impact.
Verification
jquery removal — correct and safe.sphinxcontrib.jquery is already in the extensions list (conf.py:247), so Sphinx loads it during config init. The app.setup_extension(...) call in setup() is genuinely redundant. ✅
black compatibility — confirmed OK. I ran black 26.5.1 with --line-length 120 (the version/config CI uses, per .github/workflows/black.yaml) against the reformatted blocks: both pass. The trailing commas trigger black's magic-trailing-comma behavior, so it keeps them expanded rather than collapsing. No CI failure. ✅ (Note: the single-line originals also pass black, so this reformat is a style preference, not a fix.)
Issues
Description ↔ diff mismatch (main concern). The description says "Removed the unused initial extensions = [] assignment." — but the diff does not do this. conf.py:29 still holds extensions = [], and it is in fact dead code: fully overwritten by the second extensions = [...] at conf.py:241, with no append/+= in between. So the one change that would be a real cleanup is claimed but missing. The cleaner fix is to merge the two extensions assignments (delete line 29) — having two top-level extensions = bindings is the actual confusing thing in this file.
Stray blank line. The reflow inserts a blank line between the # Custom sidebar templates... comment and the html_sidebars assignment it documents, slightly divorcing the comment from its target. Minor.
Churn vs. value. Aside from the jquery line, this is purely cosmetic reformatting that black neither requires nor rejects, which adds diff noise without changing output.
Recommendation
The jquery removal is a legitimate, safe cleanup. Before merging, consider either actually removing line 29 (extensions = []) — ideally collapsing the two extensions assignments into one — so the diff matches the description, and/or dropping the two reformatting hunks if the goal is a minimal cleanup. No correctness, security, or performance concerns.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Checklist
master(or maintenance branch if only applicable there)toxor the relevant test subset)Summary
This PR performs minor cleanup in the Sphinx configuration file:
app.setup_extension("sphinxcontrib.jquery")call.extensions = []assignment.html_sidebarsfor better readability.extlinksdictionary for consistency.Type of Change
Testing