# HG changeset patch
# User Jordi Gutiérrez Hermoso <jordigh@octave.org>
# Date 1571752908 14400
# Node ID bec734015b7035f7d948a031f52d42df663a7693
# Parent  13b8097dccbf8e7618a12cd20eaedde6fe4a5260
censor: document that some commands simply ignore censored data

I can't see a benefit for hg grep to ever error out early when it
encounters censored data.

diff -r 13b8097dccbf -r bec734015b70 hgext/censor.py
--- a/hgext/censor.py	Tue Oct 22 09:56:40 2019 -0400
+++ b/hgext/censor.py	Tue Oct 22 10:01:48 2019 -0400
@@ -23,6 +23,9 @@
 ``hg update``, must be capable of tolerating censored data to continue to
 function in a meaningful way. Such commands only tolerate censored file
 revisions if they are allowed by the "censor.policy=ignore" config option.
+
+A few informative commands such as ``hg grep`` will unconditionally
+ignore censored data and merely report that it was encountered.
 """
 
 from __future__ import absolute_import