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/10/29 12:45:49 UTC
[PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
alamb opened a new pull request, #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970
## Which issue does this PR close?
Closes https://github.com/apache/arrow-datafusion/issues/7966
Related to https://github.com/apache/arrow-datafusion/pull/7964
## Rationale for this change
When crates are published to crates.io they should have a meaningful readme that explains what they do
## What changes are included in this PR?
1. Add README.md to `core`, `execution` and `physical-plan` crates, consistent with the other datafusion crates
2. Update wasmtest crate readme to have the same introductory structure
## Are these changes tested?
by CI / prettier
## Are there any user-facing changes?
Hopefully crates.io will look more polished
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on code in PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970#discussion_r1376208509
##########
datafusion/wasmtest/README.md:
##########
@@ -17,9 +17,16 @@
under the License.
-->
-## wasmtest
+# DataFusion wasmtest
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion ised to verify that various DataFusion crates compile successfully to the
Review Comment:
thank you for catching these typos 🤦
##########
datafusion/wasmtest/README.md:
##########
@@ -17,9 +17,16 @@
under the License.
-->
-## wasmtest
+# DataFusion wasmtest
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion ised to verify that various DataFusion crates compile successfully to the
Review Comment:
thank you for catching these typos 🤦
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "Jefffrey (via GitHub)" <gi...@apache.org>.
Jefffrey commented on code in PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970#discussion_r1375497623
##########
datafusion/physical-plan/README.md:
##########
@@ -0,0 +1,27 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# DataFusion Common
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion that contains the `ExecutionPlan` trait and the variou implementations of that
Review Comment:
Typo for `various`
##########
datafusion/wasmtest/README.md:
##########
@@ -17,9 +17,16 @@
under the License.
-->
-## wasmtest
+# DataFusion wasmtest
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion ised to verify that various DataFusion crates compile successfully to the
Review Comment:
Typo for `used`
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "Dandandan (via GitHub)" <gi...@apache.org>.
Dandandan commented on code in PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970#discussion_r1375891927
##########
datafusion/physical-plan/README.md:
##########
@@ -0,0 +1,27 @@
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+# DataFusion Common
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion that contains the `ExecutionPlan` trait and the variou implementations of that
Review Comment:
```suggestion
This crate is a submodule of DataFusion that contains the `ExecutionPlan` trait and the various implementations of that
```
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb commented on PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970#issuecomment-1785176207
Thank you @Dandandan and @Jefffrey
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "Dandandan (via GitHub)" <gi...@apache.org>.
Dandandan commented on code in PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970#discussion_r1375892693
##########
datafusion/wasmtest/README.md:
##########
@@ -17,9 +17,16 @@
under the License.
-->
-## wasmtest
+# DataFusion wasmtest
+
+[DataFusion](df) is an extensible query execution framework, written in Rust, that uses Apache Arrow as its in-memory format.
+
+This crate is a submodule of DataFusion ised to verify that various DataFusion crates compile successfully to the
Review Comment:
```suggestion
This crate is a submodule of DataFusion used to verify that various DataFusion crates compile successfully to the
```
--
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
Re: [PR] Add README.md to `core`, `execution` and `physical-plan` crates [arrow-datafusion]
Posted by "alamb (via GitHub)" <gi...@apache.org>.
alamb merged PR #7970:
URL: https://github.com/apache/arrow-datafusion/pull/7970
--
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