akka/akka-http

Link to generic type parameters from the documentation

Open

#1,651 opened on Dec 18, 2017

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Scala (598 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (1,311 stars)
PR merge metrics
 (Avg merge 1d 10h) (2 merged PRs in 30d)

Description

Currently, @unidoc[Source[Foo, Bar]] links to Source.

It would be neat if we could add logic to the unidoc directive to also link to Foo and Bar.

Contributor guide

Research direction
Investigate how the `@unidoc` directive resolves type references and modify the logic to also link to generic type parameters like `Foo` and `Bar`.
Tech stack
scala
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Scala
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75