rdoc
rdoc copied to clipboard
ruby
RDoc produces HTML and online documentation for Ruby projects.
When `--embed-mixins` option is set: - methods from an `extend`ed module are documented as singleton methods - attrs from an `extend`ed module are documented as class attributes - methods from...
Memoizes the expensive module lookup of RDoc::Mixin#module. Note: It may be that a memoization of the result is not feasable due to changes in the loaded datastructures between calls, which...
Optimizes finding the character offset for strings that include no multibyte characters. Note: I'm no expert in string encodings, but my naive assumption is if there are as many bytes...
With history support enabled, navigating deeper nested namespaces is a more enjoyable experience.
https://github.com/rubygems/guides/commit/9af4d01d3d4ee7fa901c41f1949e13baeabfbd0d#commitcomment-63129936
There is a wrong representation of `File::Constants` module as a `File::File::Constants`: https://docs.ruby-lang.org/en/trunk/File/File/Constants.html. I believe the root causes are: * `dir.c`, defining some constants, parsed before `file.c`, defining the module; *...
When commenting a section like ``` # :section: Some Section # Some documentation for the section here ``` the section is created but the documentation is not shown in the...
The documenetation for the `Regexp` class in the standard library uses `` which is escaped as you can see here: https://ruby-doc.org/core-3.0.1/Regexp.html#class-Regexp-label-Capturing > Parentheses can be used for _capturing_. The text...
