From bb8e0e778939e7c0c1ed1d5e2520d6d7faf70dd3 Mon Sep 17 00:00:00 2001 From: Kovid Goyal Date: Sat, 2 Jun 2018 13:09:18 +0530 Subject: [PATCH] Add CLI docs for the diff kitten --- docs/kittens/diff.rst | 5 +++++ kittens/diff/main.py | 9 +++++++-- 2 files changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/kittens/diff.rst b/docs/kittens/diff.rst index 38d70c3ed..330fdb26e 100644 --- a/docs/kittens/diff.rst +++ b/docs/kittens/diff.rst @@ -122,6 +122,11 @@ Now to use kitty-diff to view git diffs, you can simply do:: Once again, creating an alias for this command is useful. +Command Line Interface +------------------------- + +.. include:: /generated/cli-kitten-diff.rst + Why does this work only in kitty? ---------------------------------------- diff --git a/kittens/diff/main.py b/kittens/diff/main.py index d077369e1..04b89dc15 100644 --- a/kittens/diff/main.py +++ b/kittens/diff/main.py @@ -383,12 +383,13 @@ def showwarning(message, category, filename, lineno, file=None, line=None): showwarning.warnings = [] +help_text = 'Show a side-by-side diff of the specified files/directories' +usage = 'file_or_directory_left file_or_directory_right' def main(args): warnings.showwarning = showwarning - msg = 'Show a side-by-side diff of the specified files/directories' - args, items = parse_args(args[1:], OPTIONS, 'file_or_directory file_or_directory', msg, 'kitty +kitten diff') + args, items = parse_args(args[1:], OPTIONS, usage, help_text, 'kitty +kitten diff') if len(items) != 2: raise SystemExit('You must specify exactly two files/directories to compare') left, right = items @@ -414,3 +415,7 @@ def main(args): if __name__ == '__main__': main(sys.argv) +elif __name__ == '__doc__': + sys.cli_docs['usage'] = usage + sys.cli_docs['options'] = OPTIONS + sys.cli_docs['help_text'] = help_text