Skip to content

Commit 5a643f9

Browse files
committed
Fix docs
1 parent b06b0dc commit 5a643f9

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

docs/usage/configuration/headings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -671,7 +671,7 @@ plugins:
671671
- **:octicons-package-24: Type [`bool`][] :material-equal: `False`{ title="default value" }**
672672
<!-- - **:octicons-project-template-24: Template :material-null:** (N/A) -->
673673

674-
Whether to not give objects local inventory entries and permalinks.
674+
Whether to not give objects local inventory entries.
675675

676676
With this option enabled, re-rendering docstrings for objects from external inventories is possible with their cross-references pointing to the original external inventory, not local.
677677

src/mkdocstrings_handlers/python/_internal/config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -869,7 +869,7 @@ class PythonInputOptions:
869869
bool,
870870
_Field(
871871
group="headings",
872-
description="Whether to not give objects local inventory entries and permalinks.",
872+
description="Whether to not give objects local inventory entries.",
873873
),
874874
] = False
875875

0 commit comments

Comments
 (0)