rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
In the current version of RDoc, when searching for class definition APIs such as `rb_define_class` and `rb_define_method` in a C file, if a match is found in that file, it...
## Abstract I'd like to propose an extension system for RDoc. [YARD](https://yardoc.org/) has been popular for years and new comment usages such as [rbs-inline](https://github.com/soutaro/rbs-inline) has been introduced. We need to...
I'm following [this](https://ruby.github.io/rdoc/RDoc/Task.html) documentation on how to add a rake task for generating the documentation. After defining the rake task trying to run `rake rdoc` raises ```zsh rake aborted! Don't...
It would be nice to have a preview of the documentation if changes are made. This has been done for SDoc as well: https://github.com/rails/sdoc/pull/163
I think it's time to take a look at having something more friendly and accessible to the eyes. Let's use this ticket to capture some ideas and see if we...
I'm looking at file selection for the `rdoc` command. I see in the code that certain files and directories are excluded by default: - Each file whose name ends with...
This is an attempt to utilize RuboCop further. RuboCop was added in 9262fdd43a3a87403dc095e096f968576cd611d9 but only a few rules have been enabled. I believe we can utilize RuboCop more for better...
This happens on 3.3.3 and 3.3.4. Dunno when it started but HTML needs to be removed from ri output. ``` 10007 $ ri File.flock = File.flock (from ruby core) ------------------------------------------------------------------------...
## Background This is not a "bug", because it says > This parser is meant to parse the MRI ChangeLog, but can be used to parse any # {GNU style...
