apache / apache/arrow-java

[Java][Doc] Add JavaDoc to TransferPair interface

Offen
#247 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Component: Documentation Type: enhancement
Vorherrschende Sprache
Java
Sterne
94
Forks
152
Ø Merge
3 T. 16 Std.
Gemergte PRs (30 T.)
11

Beschreibung

The TransferPair interface is important to the Java vector module's memory management, but there is only a single line class comment, and no comments for the methods. The implementations of those methods have subtitles that are hidden in the method names. For example, the method transferTo() clears the memory in the original vector and resets the rowCount to 0, but splitAndTransferTo() only copies the values into new memory and the original is unchanged.  

**Reporter**: [Larry White](https://issues.apache.org/jira/browse/ARROW-17570) / @lwhite1

**Note**: *This issue was originally created as [ARROW-17570](https://issues.apache.org/jira/browse/ARROW-17570). Please see the [migration documentation](https://github.com/apache/arrow/issues/14542) for further details.*

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Locate the Java vector module's TransferPair interface and read its method declarations alongside their implementations. Add JavaDoc describing the distinct memory and row-count behavior of transferTo() and splitAndTransferTo(), and ensure all interface methods are documented.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
java
Bereich
backend
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
45/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.