KittyPatch/kitty
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add expected regex syntax to hints kitten docs

Browse Source 
The hints kitten's help documentation did not mention what syntax to use
for the regular expressions. I knew much of kitty was implemented in
python so I guessed correctly but not everyone might know this.

I also fixed some double-spaced sentences because most of them are
single-spaced.
This commit is contained in:
Toon Nolten
2019-08-17 19:26:45 +02:00
parent 77054f688d
commit 2575349ec2
1 changed files with 7 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
kittens/hints/main.py
View File

@@ -341,9 +341,9 @@ OPTIONS = r'''
--program --program
type=list type=list
What program to use to open matched text. Defaults to the default open program What program to use to open matched text. Defaults to the default open program
for the operating system. Use a value of :file:`-` to paste the match into the for the operating system. Use a value of :file:`-` to paste the match into the
terminal window instead. A value of :file:`@` will copy the match to the clipboard. terminal window instead. A value of :file:`@` will copy the match to the clipboard.
A value of :file:`default` will run the default open program. Can be specified A value of :file:`default` will run the default open program. Can be specified
multiple times to run multiple programs. multiple times to run multiple programs.
@@ -356,11 +356,11 @@ The type of text to search for.
--regex --regex
default=(?m)^\s*(.+)\s*$ default=(?m)^\s*(.+)\s*$
The regular expression to use when :option:`kitty +kitten hints --type`=regex. The regular expression to use when :option:`kitty +kitten hints --type`=regex.
If you specify a group in the regular expression only the group The expected syntax is python :code:`re` flavored. If you specify a group in
will be matched. This allow you to match text ignoring a prefix/suffix, as the regular expression only the group will be matched. This allow you to match
needed. The default expression matches lines. To match text over text ignoring a prefix/suffix, as needed. The default expression matches lines.
multiple lines you should prefix the regular expression with :code:`(?ms)`, To match text over multiple lines you should prefix the regular expression with
which turns on MULTILINE and DOTALL modes for the regex engine. :code:`(?ms)`, which turns on MULTILINE and DOTALL modes for the regex engine.
--url-prefixes --url-prefixes