The Wayback Machine - https://web.archive.org/web/20200608071125/https://github.com/topics/yard
Skip to content
#

yard

Here are 18 public repositories matching this topic...

yard
zverok
zverok commented Sep 1, 2017

Next step in docs check: not only correction, but also quality.

Some ideas on checks:

  • simple "undocumented X" for X in (class, method, constant, parameter, what else?);
  • unnecessary documented return value for predicate methods (YARD does it automatically);
  • wrongful documented return value type for predicate methods (when it is documented and is not boolean);
  • possibly undocumented op

Improve this page

Add a description, image, and links to the yard topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the yard topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.