From 99b004942fc75dcc5eac19a2bbcf2364b72a6827 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yago=20Gonz=C3=A1lez?= Date: Fri, 2 Jun 2017 23:48:40 +0200 Subject: [PATCH] lint: Explain the purpose of target_langs. Tweaked by tabbott to be a longer docstring. --- tools/lint | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/tools/lint b/tools/lint index 875f9a8f39..f8499a0c74 100755 --- a/tools/lint +++ b/tools/lint @@ -688,6 +688,13 @@ def run(): return func def external_linter(name, command, target_langs=[]): + """Registers an external linter program to be run as part of the + linter. This program will be passed the subset of files being + linted that have extensions in target_langs. If there are no + such files, exits without doing anything. + + If target_langs is empty, just runs the linter unconditionally. + """ # type: (str, List[str], List[str]) -> None def run_linter(): # type: () -> int