Questions about file selection

Open
#1,163 2 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
ruby
Domain
cli

Research direction

Start at the rdoc command's default file-selection path and reproduce the no-argument run from ruby/rdoc/. Trace where exclusions for bin/, exe/, man/, and rakelib/ are applied; done means identifying the controlling logic and documenting any additional exclusions.

Written by the indexing model from the issue text.

Description

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 ~, .orig, .rej, .bak, .gemspec.
  • Each file or directory whose name begins with ..
  • Each directory named test or spec.

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

  • console in bin/.
  • rdoc and ri in exe/.
  • ri.1 in man/.
  • epock.rake in rakelib/.

Questions:

  • Where is the code that controls these?
  • Are there other exclusions that I'm not (yet) seeing?
Dominant language
Ruby
Stars
930
Forks
472
Avg merge
2d 8h
Merged PRs (30d)
12

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from ruby/rdoc

All issues in ruby/rdoc

Similar issues

More Ruby issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.