Undocumented items in TAGS style

Open
#1,446 0 comments 1 reaction 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
38/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
ruby
Domain
cli, tooling

Research direction

Start by examining how rdoc -C reports undocumented items and how RDoc handles command-line options. Define the TAGS-style output expected by editors, then verify that the new option produces jumpable entries for the reported undocumented items.

Written by the indexing model from the issue text.

Description

Feature Request

rdoc -C can report undocumented items, but the output is not suitable to jump in editors.
It would be nice to have an option to report in TAGS file style.

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.