Validate YARD docs by running your test suite

You are saying that you are always going to be passing in a User instance and the method will always returns true or false.yardcheck traces method invocations to observe the parameters and return values in your application while running your test suite. When your test suite finishes running we compare the observed types found while running your tests against the types in your documentation.