apache / apache/parquet-java

Add Yetus InterfaceAudience annotations to Parquet

Open
#2,086 0 comments 0 reactions 0 assignees View on GitHub
Component: Parquet Priority: Major Type: enhancement
Dominant language
Java
Stars
3.1k
Forks
1.6k
Avg merge
3d 12h
Merged PRs (30d)
33

Description

Parquet should use [Yetus InterfaceAudience annotations](https://yetus.apache.org/documentation/in-progress/audience-annotations-apidocs/org/apache/yetus/audience/package-summary.html) to specify its API's intended [audience](https://yetus.apache.org/documentation/in-progress/audience-annotations-apidocs/org/apache/yetus/audience/InterfaceAudience.html) (public/private) and optionally [stability](https://yetus.apache.org/documentation/in-progress/audience-annotations-apidocs/org/apache/yetus/audience/InterfaceStability.html) (unstable/evolving/stable) in code annotations both for the benefit of its users and also for ensuring that no breaking changes happen in the public API.

**Reporter**: [Zoltan Ivanfi](https://issues.apache.org/jira/secure/ViewProfile.jspa?name=zi) / @zivanfi

**Note**: *This issue was originally created as [PARQUET-1116](https://issues.apache.org/jira/browse/PARQUET-1116). Please see the [migration documentation](https://issues.apache.org/jira/browse/PARQUET-2502) for further details.*

Contributor guide

No contributing guide indexed for this repository

Research direction

No source files or tests are named. Start by reviewing the Yetus InterfaceAudience and InterfaceStability documentation, then inventory Parquet's Java API to determine which classes and methods need annotations. Done means the intended audience and, where applicable, stability are documented in code across the API, with the stated protection against breaking public changes.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.