From 19df7b94eaa33714c4eb8449610f84ef2d6144c1 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Tue, 16 Jun 2020 09:53:08 +0530 Subject: [PATCH] Clarify documentation a bit --- kittens/hints/main.py | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/kittens/hints/main.py b/kittens/hints/main.py index fe256cb28..27d8ecb36 100644 --- a/kittens/hints/main.py +++ b/kittens/hints/main.py @@ -419,10 +419,11 @@ programs. --type default=url choices=url,regex,path,line,hash,word,linenum -The type of text to search for. A value of :code:`linenum` looks for error messages -using the pattern specified with :option:`--regex`, which must have the named groups, -path and line. If not specified, will look for :code:`path:line`. -The :option:`--linenum-action` option controls what to do with the selected error message. +The type of text to search for. A value of :code:`linenum` is special, it looks +for error messages using the pattern specified with :option:`--regex`, which +must have the named groups, :code:`path` and :code:`line`. If not specified, +will look for :code:`path:line`. The :option:`--linenum-action` option +controls what to do with the selected error message, other options are ignored. --regex