Skip to content

Commit caea7d4

Browse files
committed
docs: Restructure current_doc/paths mutual exclusion note
Move the note about mutual exclusivity into a proper `.. note::` directive for better readability.
1 parent c88c3a0 commit caea7d4

1 file changed

Lines changed: 6 additions & 6 deletions

File tree

docs/usage.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,14 @@ following parameters are available:
2323

2424
``current_doc``
2525
If ``True``, only return revisions that modified the current document
26-
(default ``False``). When enabled, ``paths`` is overridden with a pathspec
27-
matching the current document.
28-
See also :example:`Recent Updates to Current Document`.
26+
(default ``False``).
27+
28+
.. note::
2929

30-
.. note::
30+
When enabled, ``paths`` is overridden with a pathspec matching the current
31+
document. So ``paths`` and ``current_doc`` are mutually exclusive.
3132

32-
``paths`` and ``current_doc`` are mutually exclusive. When ``current_doc=True``,
33-
the ``paths`` parameter is ignored.
33+
See also :example:`Recent Updates to Current Document`.
3434

3535
.. role:: py(code)
3636
:language: Python

0 commit comments

Comments
 (0)