We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent c88c3a0 commit caea7d4Copy full SHA for caea7d4
1 file changed
docs/usage.rst
@@ -23,14 +23,14 @@ following parameters are available:
23
24
``current_doc``
25
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`.
+ (default ``False``).
+
+ .. note::
29
30
-.. note::
+ When enabled, ``paths`` is overridden with a pathspec matching the current
31
+ document. So ``paths`` and ``current_doc`` are mutually exclusive.
32
- ``paths`` and ``current_doc`` are mutually exclusive. When ``current_doc=True``,
33
- the ``paths`` parameter is ignored.
+ See also :example:`Recent Updates to Current Document`.
34
35
.. role:: py(code)
36
:language: Python
0 commit comments