Skip to content

Commit 2dbd7eb

Browse files
dblockCopilot
andcommitted
Clarify README: fui finds unreferenced header files, not unused imports within files
Fixes #13. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 5553b1a commit 2dbd7eb

1 file changed

Lines changed: 5 additions & 1 deletion

File tree

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ Fui
66

77
Find unused Objective-C imports.
88

9+
> **What fui does:** finds header (`.h`) files that are never imported anywhere in your project — i.e. classes that can potentially be deleted entirely.
10+
>
11+
> **What fui does not do:** find `#import` statements within a file that are unused by that file's code. For that, use a tool like [Clang's unused-includes warning](https://clang.llvm.org/docs/DiagnosticsReference.html) or AppCode.
12+
913
# Table of Contents
1014

1115
- [Usage](#usage)
@@ -40,7 +44,7 @@ fui help
4044
fui find
4145
```
4246

43-
The `find` command lists all the files that contain unused imports and exits with the number of files found.
47+
The `find` command lists all header (`.h`) files that are not imported anywhere in the project, and exits with the number of such files found.
4448

4549
### Find Unused Classes in any Path
4650

0 commit comments

Comments
 (0)