narrowspec: document constraints when validating patterns
authorAugie Fackler <augie@google.com>
Mon, 12 Feb 2018 14:27:32 -0500
changeset 36098 9c55bbc29dcf
parent 36097 66b4ffe90676
child 36099 b8bbe589fd47
narrowspec: document constraints when validating patterns Differential Revision: https://phab.mercurial-scm.org/D2190
hgext/narrow/narrowspec.py
--- a/hgext/narrow/narrowspec.py	Mon Feb 12 14:15:52 2018 -0500
+++ b/hgext/narrow/narrowspec.py	Mon Feb 12 14:27:32 2018 -0500
@@ -83,7 +83,11 @@
     return len((s + 'x').splitlines())
 
 def _validatepattern(pat):
-    """Validates the pattern and aborts if it is invalid."""
+    """Validates the pattern and aborts if it is invalid.
+
+    Patterns are stored in the narrowspec as newline-separated
+    POSIX-style bytestring paths. There's no escaping.
+    """
 
     # We use newlines as separators in the narrowspec file, so don't allow them
     # in patterns.