Merge pull request #14 from uudashr/improve-docs

Improve documentation

Author: uudashr

README.md

@@ -8,7 +8,7 @@ It consists of several analyzers:
 1. `unused`: Identifies interfaces that are not used anywhere in the same package where the interface is defined.
 2. `identical`: Identifies interfaces in the same package with identical methods or constraints.
 3. `opaque`: Identifies functions that return interfaces, but the actual returned value is always a single concrete implementation.
-4. `unexported`: Identifies interfaces that are not exported but are used in exported functions or methods.
+4. `unexported`: Identifies interfaces that are not exported but are used in exported functions or methods as parameters or return values.
 
 ## Usage
 

unexported/doc.go

@@ -1,3 +1,4 @@
 // Package unexported defines an Analyzer that identifies interfaces that are
-// not exported but are used in exported functions or methods.
+// not exported but are used in exported functions or methods as parameters or
+// return values.
 package unexported

unexported/unexported.go

@@ -20,7 +20,7 @@ func newAnalyzer() *analysis.Analyzer {
 
 	analyzer := &analysis.Analyzer{
 		Name:     "unexported",
-		Doc:      "Identifies interfaces that are not exported but are used in exported functions or methods",
+		Doc:      "Identifies interfaces that are not exported but are used in exported functions or methods as parameters or return values",
 		URL:      "https://pkg.go.dev/github.com/uudashr/iface/visibility",
 		Requires: []*analysis.Analyzer{inspect.Analyzer},
 		Run:      r.run,