ShaiviAgarwal2 opened a new pull request, #45160:
URL: https://github.com/apache/arrow/pull/45160
<!--
Thanks for opening a pull request!
If this is your first pull request you can find detailed information on how
to contribute here:
* [New Contributor's
Guide](https://arrow.apache.org/docs/dev/developers/guide/step_by_step/pr_lifecycle.html#reviews-and-merge-of-the-pull-request)
* [Contributing
Overview](https://arrow.apache.org/docs/dev/developers/overview.html)
If this is not a [minor
PR](https://github.com/apache/arrow/blob/main/CONTRIBUTING.md#Minor-Fixes).
Could you open an issue for this pull request on GitHub?
https://github.com/apache/arrow/issues/new/choose
Opening GitHub issues ahead of time contributes to the
[Openness](http://theapacheway.com/open/#:~:text=Openness%20allows%20new%20users%20the,must%20happen%20in%20the%20open.)
of the Apache Arrow project.
Then could you also rename the pull request title in the following format?
GH-${GITHUB_ISSUE_ID}: [${COMPONENT}] ${SUMMARY}
or
MINOR: [${COMPONENT}] ${SUMMARY}
-->
### Rationale for this change
We have added the missing documentation for various tensor classes in
PyArrow, specifically `SparseCOOTensor`, `SparseCSRMatrix`, `SparseCSCMatrix`,
and `SparseCSFTensor`. This documentation is necessary to provide users with
reference information and examples on how to use these classes, as currently,
there is no reference documentation or information in the PyArrow user guide
regarding these tensor classes.
### What changes are included in this PR?
1. Added docstrings to the `SparseCSRMatrix`, `SparseCSCMatrix`, and
`SparseCSFTensor` classes and their methods in the `tensor.pxi` file.
2. Updated the `tables.rst` file to include documentation for
`SparseCSFTensor` along with examples.
### Are these changes tested?
No new tests are included in this PR as the changes are purely documentation
updates. The existing tests for the tensor classes should cover the
functionality.
### Are there any user-facing changes?
Yes, the user-facing change is the addition of documentation for the tensor
classes, which will help users understand and utilize these classes more
effectively. There are no breaking changes to public APIs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
