akka/akka-core

UnsupportedOperationException for the returned `List<T>` in groupedWithin` should be metioned in JavaDoc.

Open

#31,151 opened on Feb 21, 2022

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Scala (13,277 stars) (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Description

Which returns a wrapper and cann't support set operation, should that be metioned in docs?

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.
1
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The groupedWithin method is in akka stream library. Update its ScalaDoc/JavaDoc to mention that the returned list does not support the set operation. Review existing documentation in the same file for style. No linked PRs or assignees, so this is free for contribution.