Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Installing octokit barfs on Yard documentation #84

Closed
miketheman opened this Issue · 5 comments

4 participants

@miketheman

Using Ruby 1.9.3 p194

Output:

$ gem install octokit
Successfully installed octokit-1.0.4
1 gem installed
Installing ri documentation for octokit-1.0.4...
Building YARD (yri) index for octokit-1.0.4...
[error]: ParserSyntaxError: syntax error in `LICENSE`:(1,18): syntax error, unexpected tINTEGER, expecting $end
[error]: Stack trace:
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/ruby/ruby_parser.rb:517:in `on_parse_error'
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/ruby/ruby_parser.rb:15:in `parse'
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/source_parser.rb:438:in `parse'
    /Users/michael/.rvm/gems/ruby-1.9.3-p194@github/gems/yard-0.7.5/lib/yard/parser/source_parser.rb:361:in `parse_in_order'

Installing RDoc documentation for octokit-1.0.4...

May have something to do with how yard (0.7.5) is being called for the LICENSE file.

@pengwynn
Owner

Seeing this issue on several projects on GitHub with no stated resolution. Maybe @lsegal might know?

@lsegal

YARD assumes all files in the .document file are ruby sources. You can add a "-" between the last ruby file and the non Ruby files to tell YARD that the rest are non-Ruby files. RDoc shouldn't mind this. Just as a sidenote, YARD isn't exactly "barfing" here, it's just notifying you of a parse error and continuing to document the rest of your source without issue.

@miketheman

@lsegal Apologies, I was using barf in the most liberal sense, as something was coming out that I wasn't expecting. Would shart be better? :smirk:

@miketheman miketheman referenced this issue from a commit in miketheman/octokit
@miketheman miketheman Fix for #84, Yard documentation error 6d37308
@lsegal

FYI https://rubydoc.tenderapp.com/kb/getting-started-with-rubydocinfo/setting-up-a-yardopts-file

@miketheman I was just pointing out that it's purely visual noise. It doesn't affect the resulting docs.

@catsby
Collaborator

Fixed with #85

@catsby catsby closed this
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.