Questions about file selection
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
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
testorspec.
When I run rdoc (no arguments or options) in ruby/rdoc/, certain other files (and possibly directories) are excluded:
consoleinbin/.rdocandriinexe/.ri.1inman/.epock.rakeinrakelib/.
Questions:
- Where is the code that controls these?
- Are there other exclusions that I'm not (yet) seeing?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
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.
Assessment
- Tech stack
- ruby
- Domain
- cli
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100