Render parameters and return discussion in jazzy
Open
Nobody has claimed this yet.
enhancement
- Dominant language
- Swift
- Stars
- 2.4k
- Forks
- 237
- PR merge metrics
- No merged PRs in 30d
Description
Since these are now just markdown list items, this should be relatively easy. However, I had a really hard time figuring out the best way to do so in redcarpet, so this is something I could really use @segiddins's help with 😉.
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 jazzy's rendering path and its redcarpet integration, then inspect how parameter and return discussions are represented as Markdown list items. Confirm the desired output and implement rendering for both sections; done means generated jazzy documentation includes them correctly. No file or test is named, so locate the relevant renderer and coverage first.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100