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 (3,547 forks)batch import
1 - triagedhelp wantedt:docs

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

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

Contributor guide

Research direction
Locate the `groupedWithin` method in the Java API documentation and add a note that the returned list is an unmodifiable wrapper that throws UnsupportedOperationException on mutation attempts.
Tech stack
None
Domain
backend
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Java
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85