#
yard
Here are 18 public repositories matching this topic...
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
Static Analyzer and Language Server for Ruby
-
Updated
Oct 6, 2019 - Ruby
pavlitsky
commented
Oct 18, 2018
Add basic validation for method's parameters. If they're invalid then don't document either entire method or only skip its parameters.
Bad params examples:
def foo(bar, baz qux)
enddef foo ; endEasily push yard docs to Github Pages
-
Updated
May 22, 2018 - Ruby
Run any *.rb file from command line. CLI for Ruby classes. It's like Python Fire but for Ruby!
ruby
bash
cli
console
ruby-gem
parser
devops
command-line
annotations
executable
yardoc
command-line-tool
yard
trollop
-
Updated
Apr 3, 2020 - Ruby
A YARD plugin to allow relative links between Markdown files.
-
Updated
Mar 6, 2020 - Ruby
A YARD plugin for documenting Chef cookbooks
-
Updated
Oct 7, 2017 - Ruby
Repo for RYDG project
-
Updated
May 4, 2017 - JavaScript
Lightweight Sinatra app for shopify inventory reporting automation
-
Updated
Mar 6, 2018 - Ruby
Improve this page
Add a description, image, and links to the yard topic page so that developers can more easily learn about it.
Add this topic to your repo
To associate your repository with the yard topic, visit your repo's landing page and select "manage topics."


On https://www.rubydoc.info/gems/yard/file/docs/Tags.md#attr, the docs for
@attrare:However the example given is:
The name and the types are inverted.