akka/akka-http

FormData.fromPath is missing from scaladoc

Open

#2,052 opened on Jun 5, 2018

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

Description

https://doc.akka.io/api/akka-http/current/akka/http/scaladsl/model/FormData$.html does not show the fromPath method.

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.
clear
Prerequisites
Scalascaladoc
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
Look at the source code for akka http's FormData object, specifically the fromPath method. Check if the method is already documented in the source code but not published, or if it's missing a scaladoc comment. Then add the appropriate scaladoc to make it appear on the API documentation page. Refer to the comment thread for any additional details.