apache / apache/arrow-java

[Java][Doc] Add JavaDoc to TransferPair interface

Aperta
#247 1 commento 0 reazioni 0 assegnatari Vedi su GitHub
Component: Documentation Type: enhancement
Lingua principale
Java
Stelle
94
Fork
152
Merge medio
3g 16h
PR unite (30g)
11

Descrizione

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.*

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
backend
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.