apache / apache/arrow-java

[Java][Doc] Add JavaDoc to TransferPair interface

Ouverte
#247 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub
Component: Documentation Type: enhancement
Langage dominant
Java
Étoiles
94
Forks
152
Merge moyen
3 j 16 h
PR mergées (30 j)
11

Description

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

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

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.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
java
Domaine
backend
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.