akka/akka-http

Revisit note regarding Marshaller.oneOf

Open

#1,083 opened on May 3, 2017

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Scala (1,311 stars) (598 forks)batch import
1 - triagedhelp wantedt:docst:marshalling

Description

In da842017a1af88a486dfd1a8e6c37384905faeb7 a note was added to scaladoc which might not be accurate any more after adding the resolution in https://github.com/akka/akka-http/pull/1019.

Contributor guide

Tech stack
scala
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with scaladocunderstanding of Marshaller.oneOf
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Review commit da84201 and PR #1019 to understand the current state of Marshaller.oneOf. Compare the note in scaladoc with the actual behavior after the resolution. Update the note if it is no longer accurate.
Revisit note regarding Marshaller.oneOf · akka/akka-http#1083 | Good First Issue