rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
(`rdoc --version`: `6.4.0`) RDoc (and by extension, [YARD](https://yardoc.org/) out-of-the-box) has Markdown support, but it doesn’t work correctly when it comes to nested emphasis/strong text, in-line code and links. Refer to...
I cannot get the inline HTML extension to work with the standalone RDoc Markdown generator. Below is a test using the example from [the documentation](https://ruby-doc.org/stdlib-2.6/libdoc/rdoc/rdoc/RDoc/Markdown.html#method-i-break_on_newline). The expected output should have...
I think the best RDoc markup reference is in the file [doc/rdoc/markup_reference.rb](https://github.com/ruby/rdoc/blob/master/doc/rdoc/markup_reference.rb). But it's hidden from the official documentation in https://ruby.github.io/rdoc/. (Maybe it's because it's not in the `lib` folder?...
See YARD Tags doc for [param](http://rubydoc.info/gems/yard/file/docs/Tags.md#param) and [return](http://rubydoc.info/gems/yard/file/docs/Tags.md#return). This comes from a discussion in rails/rails#13989. I'd like to define the api for this feature and provide support for the tags...
``` ruby 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86_64-linux] rdoc 6.3.1 ``` Create the following ruby file in some folder: ``` # https://github.com/ruby/ruby/blob/master/README.md class Klass end ``` Run `rdoc` in that folder....
Introduce the new format similar to the `.gitignore` file by starting with the comment `rdoc.document: 1`. - one pattern per line - negative pattern starting with `!` - escaping space...
It seems that RDoc does not yet support the endless method at this time. Here is a small example: `lib/main.rb`: ```ruby class AAA def aaa = :aaa end class BBB;...
I'm referring to the `#group_by` method. The use example: ``` (1..6).group_by { |i| i%3 } ``` Shows an erroneous return value, namely: `#=> {0=>[3, 6], 1=>[1, 4], 2=>[2, 5]}`. It...
A surprising amount of gems include their test suites in the gem distribution (out of 185 gems in my current gem set, 78 include a first-level 'spec' or 'test' directory....
