Skip to content
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

Jump to bottom

RFC: Use YARD to document API #4538

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

RFC: Use YARD to document API #4538

wants to merge 1 commit into from

Commits on Jan 17, 2024

  1. RFC: Use YARD to document API 

    Motivation:

1. While rubydoc.org understands some of the current documentation format, there are other tools that do not.
Most notable example is RubyMine.
2. Tools (including rubydoc.org) cannot infer nullability from current documentation (should I say "nillability" in Ruby?).
3. Tools (including rubydoc.org) do not properly understand variant types.
4. Things like visibility are already described by code itself and feel redundant.
    @slonopotamus
    slonopotamus committed Jan 17, 2024
    Configuration menu
    Copy the full SHA
    8c16db3 View commit details
    Browse the repository at this point in the history