End to end testing for `RDoc#generate`
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Currently no tests cover RDoc#generate which means we're not testing:
- The file generation logic
- The output message of doc generation
To test it right, we need to make sure we generate the documentation in a isolated place (e.g. a temp folder) and the files must be cleaned up after each test run.
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
Locate RDoc#generate and the existing test structure first. Add end-to-end coverage for file generation and the documentation output message, using an isolated temporary folder and cleaning generated files after each test run.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- testing
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 48/100