Shared method definition duplicates method name in the main body of the rdocs
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
"===" and "==" in numeric.c refer to the same method definitions.
When running rdoc over numeric.c the results include "===" in the list of methods but the link goes to a item title "==".
"==" appears twice in the main body of the resulting docs; there is no "===" in the main body.
I.e., this appears twice in the main body:
fix == other → true or false
edit: The method defs are in numeric.c, but the issue manifests itself n Fixnum.html
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 with the method definitions in numeric.c and reproduce the RDoc output for Fixnum.html. Trace why the shared definitions for "===" and "==" produce a duplicate "==" entry and an incorrect link target. Done means the generated documentation has distinct method entries, correct titles, and no duplicate "==" body text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100