remove ambiguity of Setup/StartBundle javadocs in DoFn

Open Beginner friendly
#19,699 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

Research direction

Start with the Java declarations for the @Setup and @StartBundle annotations and read their current Javadocs. Clarify that @Setup prepares the DoFn instance while @StartBundle prepares each bundle, then verify the updated wording against nearby lifecycle documentation.

Written by the indexing model from the issue text.

Description

core improvement java P3

@Setup: "Annotation for the method to use to prepare an instance for processing bundles of elements."
@StartBundle: " Annotation for the method to use to prepare an instance for processing a batch of elements."

seems the same whereas first is initialization of the DoFn whereas second is initialization of the bundle.

Imported from Jira BEAM-7646. Original Jira may contain additional context.
Reported by: echauchot.

Dominant language
Java
Stars
8.7k
Forks
4.7k
Avg merge
2d 6h
Merged PRs (30d)
194

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/beam

All issues in apache/beam

Similar issues

More Java issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.