rdoc does not track C externs for classes/modules
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
When a *.c file describes a class, with methods, etc., and a *.rb exists owning the same class name, then the *.rb wins completely.
Example: ext/fiddle/closure.c and ext/fiddle/lib/fiddle/closure.rb
The *.c includes two methods, but when the documentation is generated, on the the attributes described in the *.rb are present for the Fiddle::Closure class.
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
Reproduce documentation generation for ext/fiddle/closure.c and ext/fiddle/lib/fiddle/closure.rb, then trace how RDoc combines class definitions from the two files. Done means the generated Fiddle::Closure documentation includes the methods described in the C file as well as the Ruby attributes.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100