Missing DoFn annotations documentation
- Dominant language
- Java
- Stars
- 8.7k
- Forks
- 4.7k
- Avg merge
- 1d 20h
- Merged PRs (30d)
- 196
Description
Not all `DoFn` annotations are covered by the programming guide.
Only `@ProcessElement` is currently covered.
We should have documentation for the other (non-expermintal at least) annotations:
```
public @interface Setup
public @interface StartBundle
public @interface FinishBundle
public @interface
Teardown
```
Imported from Jira [BEAM-1957](https://issues.apache.org/jira/browse/BEAM-1957). Original Jira may contain additional context.
Reported by: aviemzur.
Contributor guide
Research direction
Start with the programming guide section that documents @ProcessElement and compare it with the DoFn annotations listed in the issue. Add coverage for the non-experimental annotations—@Setup, @StartBundle, @FinishBundle, and @Teardown—and consider the original Jira issue for additional context. Done means the programming guide documents those annotations alongside @ProcessElement.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 35/100