ruby / ruby/rdoc

Options -r and -o should be combinable

Open
#224 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Ruby
Stars
930
Forks
465
Avg merge
3d 10h
Merged PRs (30d)
27

Description

This module should explain it:

# When using the 'r' and 'o' option together, you should be able to combine the
# flags into one command to generate ri documentation for a given output
# destination. Such as:
#
# rdoc -ro mydocs lib/mylib.rb
#
module MyLib
  def yaknow
    puts "oh, totally"
  end
end

When you try: rdoc -ro mydocs lib/mylib.rb what you actually see is:

invalid options: -ro
(invalid options are ignored)

Contributor guide

Open the contributing guide

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.

Research direction

Reproduce the behavior with rdoc -ro mydocs lib/mylib.rb and compare it with the separate -r and -o options. Trace the rdoc command-line option parsing and make the combined flags accepted while preserving the requested ri documentation destination; done when the example command succeeds without the invalid-options warning.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
cli, documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.