Skip to content

Using yarddoc and spring together results in RuntimeError for every file #298

Open
@jferris

Description

@jferris

This was pretty hard to track down, and I'm not really sure whose fault it is, but here we go:

In b14e58a, Spring redefines raise on Kernel.

Yard defines methods for all of its tags, such as @param and @raise. It's hard to figure out exactly where this goes wrong, but when Yard tries to invoke raise to generate that tag, it ends up finding Spring's version of the method, which results in the following error for every file:

[error]: Exception occurred while generating 'ClassName.html'
[error]: RuntimeError: 
[error]: Stack trace:
  /path/to/yard/templates/template.rb:355:in `render_section'

The end result is that you cannot use yardoc on Rails projects which use Spring.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions