[couchdb] 04/04: add a notice that purge documents are only visible with `include_system=true`

[va...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

vatamane pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/couchdb.git

commit ac600d1bb9c9b5335abecc954abf9dd496a2f846
Author: Christian Kruse <cj...@defunct.ch>
AuthorDate: Fri Feb 24 22:11:05 2023 +0100

    add a notice that purge documents are only visible with `include_system=true`
---
 src/docs/src/cluster/purging.rst | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/src/docs/src/cluster/purging.rst b/src/docs/src/cluster/purging.rst
index 2d8f00ed5..cc9087d89 100644
--- a/src/docs/src/cluster/purging.rst
+++ b/src/docs/src/cluster/purging.rst
@@ -66,8 +66,10 @@ Local Purge Checkpoint Documents
 Indexes and internal replications of the database with purges create and
 periodically update local checkpoint purge documents:
 ``_local/purge-{type}-{hash}``. These documents report the last ``purge_seq``
-processed by them and the timestamp of the last processing. An example of a
-local checkpoint purge document:
+processed by them and the timestamp of the last processing. These documents
+are only visible in ``_local_docs`` when you add a ``include_system=true``
+parameter, so e.g. ``/test-db/_local_docs?include_system=true``. An example
+of a local checkpoint purge document:
 
 .. code-block:: json