Linking to classes on call-seq does not work
Open
Nobody has claimed this yet.
Feature Request
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
I'm documenting a C file, say I leave a comment like this,
/*
* call-seq:
* Math.tan(Numeric : x) -> Float
*
It gets parsed correctly, but the output HTML does not link to classes Numeric or Float.
I'm down to fix this, i'd appreciate a pointing finger to the relevant code though :)
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 C comment with a call-seq entry and follow how call-seq text is parsed and rendered into HTML. The work is done when class names such as Numeric and Float in the generated call sequence link to their documentation.
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
- 38/100