Too much spoils, too little does not satisfy
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
Hi everyone at rdoc.
If there is anything wrong or this issue was already discussed, I'm so sorry.
Anyway, please look at this.
# This doc isn't generated.
define_method('foo1') do
end
# This doc is generated.
def foo2; end if false
But I expect it should be .. ↓
# This doc should be generated.
define_method('foo1') do
end
# This doc should not be generated.
def foo2; end if false
Is there any reason or difficult to do that?
I would appreciate it if you could tell me when you have a time.
Thank you.
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 by reproducing the two Ruby examples in RDoc and trace how define_method and a method guarded by if false are classified for documentation generation. Done means the generated documentation includes foo1 and excludes foo2 as shown in the issue.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100