Class documentation doesn't show `prepend`ed classes
Open
Nobody has claimed this yet.
- Dominant language
- Ruby
- Stars
- 930
- Forks
- 465
- Avg merge
- 3d 10h
- Merged PRs (30d)
- 27
Description
The class documentation does have code to identify included and extended classes. However, prepended classes are not shown. See for example https://hexapdf.gettalong.org/documentation/reference/api/HexaPDF/Encryption/FastAES.html and https://github.com/gettalong/hexapdf/blob/master/lib/hexapdf/encryption/fast_aes.rb#L54
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 examining the class-documentation handling for included and extended classes, then compare its output with the example in lib/hexapdf/encryption/fast_aes.rb at line 54. Done means the generated class documentation also shows classes prepended with prepend, matching the existing include and extend behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- ruby
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 65/100