ruby / rdoc

RDoc produces HTML and online documentation for Ruby projects.
https://ruby.github.io/rdoc/
Other
844 stars 439 forks source link

Questions about file selection #1163

Open BurdetteLamar opened 3 months ago

BurdetteLamar commented 3 months ago

I'm looking at file selection for the rdoc command.

I see in the code that certain files and directories are excluded by default:

When I run rdoc (no arguments or options) in ruby/rdoc/, certain other files (and possibly directories) are excluded:

Questions:

colby-swandale commented 2 months ago

I don't know the rules off the top of my head, but you can find code around what's removed and included at:

RDoc#normalized_file_list

https://github.com/ruby/rdoc/blob/95cc15b99e44b1a22ebbf0d9dcad432e4a690b3f/lib/rdoc/rdoc.rb#L275-L315

RDoc#remove_unparseable

https://github.com/ruby/rdoc/blob/95cc15b99e44b1a22ebbf0d9dcad432e4a690b3f/lib/rdoc/rdoc.rb#L428-L434

BurdetteLamar commented 2 months ago

Thanks, @colby-swandale; will look into this.