Skip to content

Improve documentation #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 20, 2025
Merged

Improve documentation #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 2 additions & 1 deletion unexported/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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
2 changes: 1 addition & 1 deletion unexported/unexported.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down