Skip to content
Permalink
Browse files

README: update with the recent changes

  • Loading branch information...
mvdan committed Nov 22, 2017
1 parent 679f392 commit 984be84e81dc27b585afa25fa5a4e58ff313f3a7
Showing with 8 additions and 5 deletions.
  1. +8 −5 README.md
@@ -6,16 +6,19 @@

Reports unused function parameters and results in your code.

It also reports parameters that always receive the same values, results
that always return the same values and results that are never used.

To minimise false positives, it ignores:
To minimise false positives, it ignores certain cases such as:

* Exported functions (by default, see `-exported`)
* Unnamed and underscore parameters
* Funcs that may satisfy an interface
* Funcs that may satisfy a function signature
* Funcs that are stubs (empty, only error, only return constants, etc)
* Funcs that are stubs (empty, only error, immediately return, etc)
* Funcs that have multiple implementations via build tags

It also reports results that always return the same value, parameters
that always receive the same value, and results that are never used. In
the last two cases, a minimum number of calls is required to ensure that
the warnings are useful.

False positives can still occur by design. The aim of the tool is to be
as precise as possible - if you find any mistakes, file a bug.

0 comments on commit 984be84

Please sign in to comment.
You can’t perform that action at this time.