finagle / finagle/finch

Add documentation about Mapper capabilities

Open
#885 0 comments 0 reactions 0 assignees View on GitHub
docs enhancement
Dominant language
Scala
Stars
1.6k
Forks
217
PR merge metrics
No merged PRs in 30d

Description

I've been asked a lot if an endpoint could return `Future` or `A` or `B`.
Currently, it states that one could consider an arity and apply function to Endpoint: https://github.com/finagle/finch/blob/master/docs/src/main/tut/user-guide.md#mapping-endpoints

The example is slightly incorrect, also it's worth to mention all possible types this function can return. On a side note, it could be useful to add an _@implicitNotFound_ message to Mapper(?) and list all these types there also

Contributor guide

Open the contributing guide

Research direction

Start in docs/src/main/tut/user-guide.md at the Mapping Endpoints section and inspect Mapper to identify the supported return types. Correct the example and document the possible return types; assess separately whether an @implicitNotFound message belongs in scope. Done means the guide accurately reflects Mapper capabilities.

Written by the indexing model from the issue text.

Assessment

Tech stack
scala
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.