院子0.7.3无法在降价和纺织品上建立我的README

Question

我已经决定将我的项目中的README文件转换为markdown,并且已经使用了yard验证了所提供的文档.所以我安装了rdiscount,将README更改为README.md并尝试:

yard doc README.md

这给了我一个警告:

[warn]: Syntax error in `readme.md`:(3,18): syntax error, unexpected tinteger, expecting $end

所以我尝试过:

yard doc -m markdown -- README.md

同样的问题.运行:

yard doc --backtrace -- README.md

提供更多信息:

[warn]: Syntax error in `readme.md`:(3,18): syntax error, unexpected tinteger, expecting $end
[error]: ParserSyntaxError: syntax error in `README.md`:(3,18): syntax error, unexpected tINTEGER, expecting $end
[error]: Stack trace:
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:505:in `on_parse_error'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:49:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/ruby/ruby_parser.rb:15:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/source_parser.rb:438:in `parse'
    /Users/wadewest/.rvm/gems/ruby-1.9.2-p290@peppercorn/gems/yard-0.7.3/lib/yard/parser/source_parser.rb:361:in `parse_in_order'

如果我尝试使用纺织品会发生同样的事情 如果有人想尝试重现问题,该项目是在github上.谢谢.

Answer 1

我认为你只是对yard选项感到困惑.帮助说:

$ yard --help doc
Usage: yard doc [options] [source_files [- extra_files]]
(if a list of source files is omitted, 
  {lib,app}/**/*.rb ext/**/*.c is used.)

Example: yardoc -o documentation/ - FAQ LICENSE
  The above example outputs documentation for files in
  lib/**/*.rb to documentation/ including the extra files
  FAQ and LICENSE.
...

所以当你这样说:

$ yard doc -m markdown -- README.md

Yard将尝试将其解释README.md为某种源文件.您README.md将被解释为Ruby源文件(它不是),并导致Ruby错误,如下所示:

unexpected tinteger, expecting $end

如果您编辑README.md了一下,您将看到错误的位置四处移动,但如果您尝试读取README.mdRuby源文件,则错误将有意义.

你不需要说任何东西README.md在运行时yard所有,yard就知道是做什么用README.md自身所有.