You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by "alamb (via GitHub)" <gi...@apache.org> on 2023/05/25 13:10:23 UTC
[GitHub] [arrow-rs] alamb opened a new pull request, #4279: Minor: Add more docstrings in arrow-flight
alamb opened a new pull request, #4279:
URL: https://github.com/apache/arrow-rs/pull/4279
# Which issue does this PR close?
Related to https://github.com/apache/arrow-rs/pull/4266
# Rationale for this change
While reviewing changes from @roeap on https://github.com/apache/arrow-rs/pull/4266 I remembered how hard the `FlightData` / `FlightInfo` structures were to use in the arrow-flight crate so I figured I would start helping with some docs
# What changes are included in this PR?
Add some docstrings
# Are there any user-facing changes?
docs
<!--
If there are user-facing changes then we may require documentation to be updated before approving the PR.
-->
<!---
If there are any breaking changes to public APIs, please add the `breaking change` label.
-->
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] viirya commented on a diff in pull request #4279: Minor: Add more docstrings in arrow-flight
Posted by "viirya (via GitHub)" <gi...@apache.org>.
viirya commented on code in PR #4279:
URL: https://github.com/apache/arrow-rs/pull/4279#discussion_r1205724305
##########
arrow-flight/src/lib.rs:
##########
@@ -400,6 +409,9 @@ impl FlightData {
}
impl FlightDescriptor {
+ /// Create a new opaque [`CMD`] `FlightDescriptor` to generate a dataset.
Review Comment:
```suggestion
/// Create a new opaque command [`CMD`] `FlightDescriptor` to generate a dataset.
```
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] viirya commented on a diff in pull request #4279: Minor: Add more docstrings in arrow-flight
Posted by "viirya (via GitHub)" <gi...@apache.org>.
viirya commented on code in PR #4279:
URL: https://github.com/apache/arrow-rs/pull/4279#discussion_r1205721064
##########
arrow-flight/src/lib.rs:
##########
@@ -383,6 +383,15 @@ impl TryFrom<SchemaResult> for Schema {
// FlightData, FlightDescriptor, etc..
impl FlightData {
+ /// Create a new [`FlightData`].
+ ///
+ /// # See Also
+ ///
+ /// See [`FlightDataEncoderBuilder`] for a higher level API to
+ /// convert a stream of [`RecordBatch`]es to `FlightData`
Review Comment:
For consistency?
```suggestion
/// See [`FlightDataEncoderBuilder`] for a higher level API to
/// convert a stream of [`RecordBatch`]es to [`FlightData`]s
```
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [arrow-rs] alamb merged pull request #4279: Minor: Add more docstrings in arrow-flight
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #4279:
URL: https://github.com/apache/arrow-rs/pull/4279
--
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: github-unsubscribe@arrow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org