From 1a50755f214b6fe9322878375ca60199f1bf3b51 Mon Sep 17 00:00:00 2001
From: scott-linder <scott.b.linder@wmich.edu>
Date: Mon, 12 Jun 2017 08:43:02 -0400
Subject: [PATCH] Document `check_ty` and its new `is_local` arg.

---
 clippy_lints/src/types.rs | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/clippy_lints/src/types.rs b/clippy_lints/src/types.rs
index b3d2a374865..0204bfff0d4 100644
--- a/clippy_lints/src/types.rs
+++ b/clippy_lints/src/types.rs
@@ -129,6 +129,11 @@ fn check_fn_decl(cx: &LateContext, decl: &FnDecl) {
     }
 }
 
+/// Recursively check for `TypePass` lints in the given type. Stop at the first
+/// lint found.
+///
+/// The parameter `is_local` distinguishes the context of the type; types from
+/// local bindings should only be checked for the `BORROWED_BOX` lint.
 fn check_ty(cx: &LateContext, ast_ty: &hir::Ty, is_local: bool) {
     if in_macro(ast_ty.span) {
         return;