Skip to content

docs: add Neovim integration guide and fix http link#5124

Merged
JelleZijlstra merged 6 commits into
psf:mainfrom
sedat4ras:docs/add-neovim-integration
May 18, 2026
Merged

docs: add Neovim integration guide and fix http link#5124
JelleZijlstra merged 6 commits into
psf:mainfrom
sedat4ras:docs/add-neovim-integration

Conversation

@sedat4ras

Copy link
Copy Markdown
Contributor

Description

This PR addresses two documentation improvements:

1. Add Neovim integration guide (fixes #3960)

Neovim has grown significantly in popularity but was completely missing from the editor integrations docs. The Vim section only covers Vim-specific plugins.

The new Neovim section covers three common approaches:

  • conform.nvim — the most popular modern formatter plugin for Neovim, with a format-on-save example
  • ALE — cross-references the existing Vim section since ALE works with both
  • Simple command — no-plugin approach using :!black % with a Lua nvim_create_user_command example

2. Fix http:// link in docs/index.md

The testimonials section linked to http://python-requests.org/ which redirects to https://. Updated to use https:// directly.

Checklist - did you ...

  • Implement any code style changes under the --preview style, following the stability policy? — N/A (docs only)
  • Add an entry in CHANGES.md if necessary? — Yes, added changelog entry for the Neovim guide
  • Add / update tests if necessary? — N/A (docs only)
  • Add new / update outdated documentation? — Yes, added Neovim section and fixed http link

@cobaltt7

Copy link
Copy Markdown
Collaborator

Please correct the PR number in the changelog

sedat4ras added a commit to sedat4ras/black that referenced this pull request May 17, 2026

@ichard26 ichard26 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I didn't manually test the conform.nvim configuration as I don't use any formatters in Neovim, but I cross reference the configuration with the documentation and it all checks out.

The other two methods look good!

sedat4ras and others added 6 commits May 18, 2026 10:49
- Add a dedicated Neovim section to the editor integrations docs,
  covering three approaches:
  - conform.nvim (recommended, with format-on-save example)
  - ALE (cross-reference to existing Vim section)
  - Simple :!black % command with a Lua user command example
- Fix http://python-requests.org/ link to use https://

Fixes psf#3960
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@cobaltt7 cobaltt7 force-pushed the docs/add-neovim-integration branch from 140864e to 85969a2 Compare May 18, 2026 15:49
@JelleZijlstra JelleZijlstra merged commit 61361b7 into psf:main May 18, 2026
12 checks passed
luketainton pushed a commit to luketainton/repos_roboluke that referenced this pull request May 23, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<26.5.1,>=26.5.0` → `<26.5.2,>=26.5.1` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.1?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.5.0/26.5.1?slim=true) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xODMuMSIsInVwZGF0ZWRJblZlciI6IjQzLjE4My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==-->

Reviewed-on: https://git.tainton.uk/repos/roboluke/pulls/450
Reviewed-by: Luke Tainton <luke@tainton.uk>
Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk>
Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>
luketainton pushed a commit to luketainton/luke_instant-msg-api that referenced this pull request May 23, 2026
This PR contains the following updates:

| Package | Change | [Age](https://docs.renovatebot.com/merge-confidence/) | [Confidence](https://docs.renovatebot.com/merge-confidence/) |
|---|---|---|---|
| [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | `<26.5.1,>=26.5.0` → `<26.5.2,>=26.5.1` | ![age](https://developer.mend.io/api/mc/badges/age/pypi/black/26.5.1?slim=true) | ![confidence](https://developer.mend.io/api/mc/badges/confidence/pypi/black/26.5.0/26.5.1?slim=true) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

</details>

---

### Configuration

📅 **Schedule**: (UTC)

- Branch creation
  - At any time (no schedule defined)
- Automerge
  - At any time (no schedule defined)

🚦 **Automerge**: Enabled.

♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.

🔕 **Ignore**: Close this PR and you won't be reminded about this update again.

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box

---

This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4xODMuMSIsInVwZGF0ZWRJblZlciI6IjQzLjE4My4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJ0eXBlL2RlcGVuZGVuY2llcyJdfQ==-->

Reviewed-on: https://git.tainton.uk/luke/instant-msg-api/pulls/260
Reviewed-by: Luke Tainton <luke@tainton.uk>
Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk>
Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>
736-c41-2c1-e464fc974 pushed a commit to Swiss-Armed-Forces/Loom that referenced this pull request Jun 6, 2026
This MR contains the following updates:

| Package | Type | Update | Change | OpenSSF |
|---|---|---|---|---|
| [black](https://github.com/psf/black) ([changelog](https://github.com/psf/black/blob/main/CHANGES.md)) | dev | minor | `26.3.1` → `26.5.1` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/psf/black/badge)](https://securityscorecards.dev/viewer/?uri=github.com/psf/black) |
| [pytest-asyncio](https://github.com/pytest-dev/pytest-asyncio) ([changelog](https://pytest-asyncio.readthedocs.io/en/stable/reference/changelog.html)) | test | minor | `1.3.0` → `1.4.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/pytest-dev/pytest-asyncio/badge)](https://securityscorecards.dev/viewer/?uri=github.com/pytest-dev/pytest-asyncio) |
| [python-gitlab](https://github.com/python-gitlab/python-gitlab) ([changelog](https://github.com/python-gitlab/python-gitlab/blob/main/CHANGELOG.md)) | dev | minor | `8.3.0` → `8.4.0` | [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/python-gitlab/python-gitlab/badge)](https://securityscorecards.dev/viewer/?uri=github.com/python-gitlab/python-gitlab) |

---

### Release Notes

<details>
<summary>psf/black (black)</summary>

### [`v26.5.1`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2651)

[Compare Source](psf/black@26.5.0...26.5.1)

##### Stable style

- Fix unstable formatting of annotated assignments whose subscript annotation contains
  an inline comment (e.g. `x: list[  # pyright: ignore[...]`) ([#&#8203;5130](psf/black#5130))
- Preserve inline comments (including `# type: ignore`) immediately before a
  `# fmt: skip` line, avoiding AST equivalence failures ([#&#8203;5139](psf/black#5139))

##### Packaging

- Correct the version in the published executables ([#&#8203;5137](psf/black#5137))

##### Documentation

- Add Neovim integration guide covering conform.nvim, ALE, and simple command approaches
  ([#&#8203;5124](psf/black#5124))

### [`v26.5.0`](https://github.com/psf/black/blob/HEAD/CHANGES.md#Version-2650)

[Compare Source](psf/black@26.3.1...26.5.0)

##### Highlights

- Add support for unpacking in comprehensions (PEP 798) and for lazy imports (PEP 810),
  both new syntactic features in Python 3.15 ([#&#8203;5048](psf/black#5048))
- Python 3.15 is now supported. Compiled wheels are not yet provided for Python 3.15, so
  performance may be slower than on existing Python versions. Wheels will be provided
  once Python 3.15 is later in its release cycle. ([#&#8203;5127](psf/black#5127))

##### Stable style

- Fix `# fmt: skip` being ignored in nested `if` expressions with parenthesized `in`
  clauses ([#&#8203;4903](psf/black#4903))
- Add syntactic support for Python 3.15 ([#&#8203;5048](psf/black#5048))
- Fix crash when an f-string follows a `# fmt: off` comment inside brackets ([#&#8203;5097](psf/black#5097))
- Preserve multiline compound statement headers when `# fmt: skip` is placed on the
  colon line ([#&#8203;5117](psf/black#5117))

##### Preview style

- Improve heuristics around whether blank lines should appear before, within and after
  groups of same-name decorated functions (such as `@overload` groups) in `.pyi` stub
  files ([#&#8203;5021](psf/black#5021))
- Fix blank lines being removed between a function and a decorated class in `.pyi` stub
  files ([#&#8203;5092](psf/black#5092))
- Prevent string merger from creating unsplittable long lines when a pragma comment
  (e.g. `# type: ignore`) follows the closing bracket ([#&#8203;5096](psf/black#5096))

##### Packaging

- Run CI on 3.15 ([#&#8203;5127](psf/black#5127))

##### Output

- Improve parse error readability by showing multi-line output with an error pointer.
  ([#&#8203;5068](psf/black#5068))
- Add `SourceASTParseError` to distinguish source parse failures from internal safety
  errors, improving error reporting when Black's lenient parser accepts input that
  `ast.parse()` rejects ([#&#8203;5080](psf/black#5080))

##### *Blackd*

- Return HTTP 400 (Bad Request) for source parse failures instead of HTTP 500, keeping
  HTTP 500 only for genuine internal safety errors ([#&#8203;5080](psf/black#5080))

##### Integrations

- Added documentation for doctest formatting tools and updated the integrations index to
  match ([#&#8203;4916](psf/black#4916))

##### Documentation

- Use "Version X.Y.Z" headings in changelog for stable permalink anchors on ReadTheDocs
  ([#&#8203;5063](psf/black#5063))
- Note in the editor integrations that the SublimeText `sublack` plugin is archived and
  unmaintained ([#&#8203;5082](psf/black#5082))

</details>

<details>
<summary>pytest-dev/pytest-asyncio (pytest-asyncio)</summary>

### [`v1.4.0`](https://github.com/pytest-dev/pytest-asyncio/releases/tag/v1.4.0): pytest-asyncio v1.4.0

[Compare Source](pytest-dev/pytest-asyncio@v1.3.0...v1.4.0)

### [1.4.0](https://github.com/pytest-dev/pytest-asyncio/tree/1.4.0) - 2026-05-26

#### Deprecated

- Overriding the *event\_loop\_policy* fixture is deprecated. Use the `pytest_asyncio_loop_factories` hook instead. ([#&#8203;1419](pytest-dev/pytest-asyncio#1419))

#### Added

- Added the `pytest_asyncio_loop_factories` hook to parametrize asyncio tests with custom event loop factories.

  The hook returns a mapping of factory names to loop factories, and `pytest.mark.asyncio(loop_factories=[...])` selects a subset of configured factories per test. When a single factory is configured, test names are unchanged.

  Synchronous `@pytest_asyncio.fixture` functions now see the correct event loop when custom loop factories are configured, even when test code disrupts the current event loop (e.g., via `asyncio.run()` or `asyncio.set_event_loop(None)`). ([#&#8203;1164](pytest-dev/pytest-asyncio#1164))

#### Changed

- Improved the readability of the warning message that is displayed when `asyncio_default_fixture_loop_scope` is unset ([#&#8203;1298](pytest-dev/pytest-asyncio#1298))
- Only import `asyncio.AbstractEventLoopPolicy` for type checking to avoid raising
  a DeprecationWarning. ([#&#8203;1394](pytest-dev/pytest-asyncio#1394))
- Updated minimum supported pytest version to v8.4.0. ([#&#8203;1397](pytest-dev/pytest-asyncio#1397))

#### Fixed

- Fixed a `ResourceWarning: unclosed event loop` warning that could occur when a synchronous test called `asyncio.run()` or otherwise unset the current event loop after pytest-asyncio had run an async test or fixture. ([#&#8203;724](pytest-dev/pytest-asyncio#724))

#### Notes for Downstream Packagers

- Added dependency on `sphinx-tabs >= 3.5` to organize documentation examples into tabs. ([#&#8203;1395](pytest-dev/pytest-asyncio#1395))

</details>

<details>
<summary>python-gitlab/python-gitlab (python-gitlab)</summary>

### [`v8.4.0`](https://github.com/python-gitlab/python-gitlab/blob/HEAD/CHANGELOG.md#v840-2026-05-28)

[Compare Source](python-gitlab/python-gitlab@v8.3.0...v8.4.0)

##### Features

- **const**: Add new Security Manager role
  ([`3738bb2`](python-gitlab/python-gitlab@3738bb2))

##### Testing

- **const**: Add tests for AccessLevel
  ([`2ab6d9f`](python-gitlab/python-gitlab@2ab6d9f))

</details>

---

 - [ ] <!-- rebase-check -->If you want to rebase/retry this MR, check this box

---

This MR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate).
<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yMDUuMiIsInVwZGF0ZWRJblZlciI6IjQzLjIwNS4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6WyJkZXBlbmRlbmNpZXMiLCJyZW5vdmF0ZSJdfQ==-->

See merge request swiss-armed-forces/cyber-command/cea/loom!526

Co-authored-by: Loom MR Pipeline Trigger <group_103951964_bot_9504bb8dead6d4e406ad817a607f24be@noreply.gitlab.com>
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.

Guide for neovim? I Found one for vim but not sure how to apply it to neovim.

4 participants