apache / apache/arrow-java

[Java][Doc] Add JavaDoc to TransferPair interface

Aberta
#247 1 comentário 0 reações 0 responsáveis Ver no GitHub
Component: Documentation Type: enhancement
Linguagem predominante
Java
Estrelas
94
Forks
152
Merge médio
3d 16h
PRs com merge (30d)
11

Descrição

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

Guia de contribuição

Abrir o guia de contribuição

Direção de pesquisa

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.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
java
Domínio
backend
Tipo de issue
Documentação
Dificuldade
2/5
Tempo estimado
1-3 horas
Status de atividade
Estagnada
Clareza
Razoavelmente clara
Facilidade para iniciantes
45/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.