End to end testing for `RDoc#generate`

Open
#1,180 1 comment 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
48/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
testing

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.

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.

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.