You are viewing a plain text version of this content. The canonical link for it is here.
Posted to github@arrow.apache.org by GitBox <gi...@apache.org> on 2022/02/10 13:04:02 UTC
[GitHub] [arrow] AlenkaF opened a new pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
AlenkaF opened a new pull request #12392:
URL: https://github.com/apache/arrow/pull/12392
This PR adds info (links to existing documentation) about styling to the New Contributor's Guide.
--
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] AlenkaF commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r818594502
##########
File path: docs/source/developers/guide/index.rst
##########
@@ -134,7 +134,8 @@ of adding a basic feature.
#. **Once you implemented the planned fix or feature, write and run tests for it**
- See detailed instructions on how to :ref:`test <testing>`.
+ See detailed instructions on how to :ref:`test <testing>`. Also check the
+ :ref:`syle of the code<styling>` before proceeding to the next step!
Review comment:
Yeah, that would be better! Will do.
--
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] thisisnic commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r818775408
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use Archery
+ can be found in the Coding Style section of the
+ :ref:`python-development`.
+
+ .. tab:: R package
+
+ For the R package you can use ``{lintr}`` or ``{styler}``
+ to check if the code follows the
+ `tidyverse style <https://style.tidyverse.org/>`_.
+
+ The instructions on how to use either of these two packages
+ can be found in the
+ `Styling an linting section of the Common developer workflow tasks <https://arrow.apache.org/docs/r/articles/developers/workflow.html#styling-and-linting>`_.
Review comment:
```suggestion
`Styling and Linting section of the Common developer workflow tasks <https://arrow.apache.org/docs/r/articles/developers/workflow.html#styling-and-linting>`_.
```
--
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] ursabot commented on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
ursabot commented on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1062760328
Benchmark runs are scheduled for baseline = 0b10a17a459da7e8d8f6b39995cfdccd5fb626b3 and contender = e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d. e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Scheduled] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/4fc5d7adce484596b0cbdf265c08d1ed...c001e11a003f466185fbb027138942fe/)
[Scheduled] [test-mac-arm](https://conbench.ursa.dev/compare/runs/4b8856ad5dbf4b5685b09faa6cbc1a8a...a644e510d5804d8bac84a19205cd0446/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/51f05b6dea904361b62aec36b622fde9...e81aa9271a134e7a8d19c35371079837/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/45b684837c2242828d5962b54fa56049...34a949ee67e247c9813e904c2b0cd8e2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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] AlenkaF commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r818594880
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
Review comment:
Link is better, agree. Will do.
--
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] jorisvandenbossche closed pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche closed pull request #12392:
URL: https://github.com/apache/arrow/pull/12392
--
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] ursabot edited a comment on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1062760328
Benchmark runs are scheduled for baseline = 0b10a17a459da7e8d8f6b39995cfdccd5fb626b3 and contender = e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d. e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/4fc5d7adce484596b0cbdf265c08d1ed...c001e11a003f466185fbb027138942fe/)
[Finished :arrow_down:0.25% :arrow_up:0.04%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/4b8856ad5dbf4b5685b09faa6cbc1a8a...a644e510d5804d8bac84a19205cd0446/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/51f05b6dea904361b62aec36b622fde9...e81aa9271a134e7a8d19c35371079837/)
[Finished :arrow_down:0.38% :arrow_up:0.04%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/45b684837c2242828d5962b54fa56049...34a949ee67e247c9813e904c2b0cd8e2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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] ursabot edited a comment on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1062760328
Benchmark runs are scheduled for baseline = 0b10a17a459da7e8d8f6b39995cfdccd5fb626b3 and contender = e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d. e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/4fc5d7adce484596b0cbdf265c08d1ed...c001e11a003f466185fbb027138942fe/)
[Finished :arrow_down:0.25% :arrow_up:0.04%] [test-mac-arm](https://conbench.ursa.dev/compare/runs/4b8856ad5dbf4b5685b09faa6cbc1a8a...a644e510d5804d8bac84a19205cd0446/)
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/51f05b6dea904361b62aec36b622fde9...e81aa9271a134e7a8d19c35371079837/)
[Finished :arrow_down:0.38% :arrow_up:0.04%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/45b684837c2242828d5962b54fa56049...34a949ee67e247c9813e904c2b0cd8e2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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] jorisvandenbossche commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
jorisvandenbossche commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r819533005
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
Review comment:
This paragraph is probably from copy pasting another file?
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
Review comment:
"To check" or "For checking"
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
Review comment:
I would maybe first mention that we use flake8 for linting, and then in a second sentence say that Archery is developed to help with this.
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use Archery
+ can be found in the Coding Style section of the
+ :ref:`python-development`.
+
+ .. tab:: R package
+
+ For the R package you can use ``{lintr}`` or ``{styler}``
+ to check if the code follows the
+ `tidyverse style <https://style.tidyverse.org/>`_.
+
+ The instructions on how to use either of these two packages
+ can be found in the
+ `Styling and Linting section of the Common developer workflow tasks <https://arrow.apache.org/docs/r/articles/developers/workflow.html#styling-and-linting>`_.
+
+Pre-commit
+----------
+
+It is useful to setup `pre-commit <https://pre-commit.com/>`_,
+multi-language package manager for pre-commit hooks. It will
Review comment:
```suggestion
a multi-language package manager for pre-commit hooks. It will
```
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use Archery
+ can be found in the Coding Style section of the
+ :ref:`python-development`.
+
+ .. tab:: R package
+
+ For the R package you can use ``{lintr}`` or ``{styler}``
+ to check if the code follows the
+ `tidyverse style <https://style.tidyverse.org/>`_.
+
+ The instructions on how to use either of these two packages
+ can be found in the
+ `Styling and Linting section of the Common developer workflow tasks <https://arrow.apache.org/docs/r/articles/developers/workflow.html#styling-and-linting>`_.
+
+Pre-commit
+----------
+
+It is useful to setup `pre-commit <https://pre-commit.com/>`_,
Review comment:
```suggestion
It is useful to set up `pre-commit <https://pre-commit.com/>`_,
```
--
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] thisisnic commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
thisisnic commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r818428322
##########
File path: docs/source/developers/guide/index.rst
##########
@@ -134,7 +134,8 @@ of adding a basic feature.
#. **Once you implemented the planned fix or feature, write and run tests for it**
- See detailed instructions on how to :ref:`test <testing>`.
+ See detailed instructions on how to :ref:`test <testing>`. Also check the
+ :ref:`syle of the code<styling>` before proceeding to the next step!
Review comment:
It's a little unclear what it means to check the style. Could we change this to a more direct instruction, e.g. "run the styler" or "run the linter to make sure the code is styled correctly", or something like that?
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
Review comment:
"connect" is a teensy bit unclear; perhaps instead something like "provide links to" or similar?
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
+to make it easier for you to find the relevant information about
+styling.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in python files we use the
Review comment:
```suggestion
To checking styling issues in Python files we use the
```
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
+to make it easier for you to find the relevant information about
+styling.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use the utility
+ can be found in the Coding Style section of the
+ :ref:`python-development`.
+
+ .. tab:: R package
+
+ For the R package you can use ``{lintr}`` or ``{styler}``
+ to check if the code follows the tidyverse style.
Review comment:
Perhaps link the words "tidyverse style" to the tidyverse style guide.
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
+to make it easier for you to find the relevant information about
+styling.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use the utility
+ can be found in the Coding Style section of the
+ :ref:`python-development`.
+
+ .. tab:: R package
+
+ For the R package you can use ``{lintr}`` or ``{styler}``
+ to check if the code follows the tidyverse style.
+
+ The instructions on how to use either of these two packages
+ can be found in the Styling an linting section of the
Review comment:
I'd put the section name in quotes
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,69 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will connect to the existing documentation
+to make it easier for you to find the relevant information about
+styling.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
+
+ The instructions on how to set up and use the utility
Review comment:
```suggestion
The instructions on how to set up and use Archery
```
--
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] ursabot edited a comment on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1062760328
Benchmark runs are scheduled for baseline = 0b10a17a459da7e8d8f6b39995cfdccd5fb626b3 and contender = e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d. e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/4fc5d7adce484596b0cbdf265c08d1ed...c001e11a003f466185fbb027138942fe/)
[Scheduled] [test-mac-arm](https://conbench.ursa.dev/compare/runs/4b8856ad5dbf4b5685b09faa6cbc1a8a...a644e510d5804d8bac84a19205cd0446/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/51f05b6dea904361b62aec36b622fde9...e81aa9271a134e7a8d19c35371079837/)
[Finished :arrow_down:0.38% :arrow_up:0.04%] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/45b684837c2242828d5962b54fa56049...34a949ee67e247c9813e904c2b0cd8e2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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] ursabot edited a comment on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
ursabot edited a comment on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1062760328
Benchmark runs are scheduled for baseline = 0b10a17a459da7e8d8f6b39995cfdccd5fb626b3 and contender = e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d. e8a1e1328f3c1bc6bf5ff7ba86057af3e37b634d is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished :arrow_down:0.0% :arrow_up:0.0%] [ec2-t3-xlarge-us-east-2](https://conbench.ursa.dev/compare/runs/4fc5d7adce484596b0cbdf265c08d1ed...c001e11a003f466185fbb027138942fe/)
[Scheduled] [test-mac-arm](https://conbench.ursa.dev/compare/runs/4b8856ad5dbf4b5685b09faa6cbc1a8a...a644e510d5804d8bac84a19205cd0446/)
[Scheduled] [ursa-i9-9960x](https://conbench.ursa.dev/compare/runs/51f05b6dea904361b62aec36b622fde9...e81aa9271a134e7a8d19c35371079837/)
[Scheduled] [ursa-thinkcentre-m75q](https://conbench.ursa.dev/compare/runs/45b684837c2242828d5962b54fa56049...34a949ee67e247c9813e904c2b0cd8e2/)
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java
--
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] AlenkaF commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r819543493
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
Review comment:
Good catch. Yes, will remove 👍
--
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] github-actions[bot] commented on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
github-actions[bot] commented on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1034898077
https://issues.apache.org/jira/browse/ARROW-15350
--
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] AlenkaF commented on pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#issuecomment-1058187986
Thank you Nic!
--
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] AlenkaF commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
Posted by GitBox <gi...@apache.org>.
AlenkaF commented on a change in pull request #12392:
URL: https://github.com/apache/arrow/pull/12392#discussion_r819543776
##########
File path: docs/source/developers/guide/step_by_step/styling.rst
##########
@@ -0,0 +1,70 @@
+.. 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.
+
+
+.. SCOPE OF THIS SECTION
+.. This section should include extra description to the
+.. language-specific documentation. Possible topics to
+.. add: How to run one test, test file or all the tests
+.. together and why is it good to do that.
+.. What if the unconnected tests start failing? etc.
+
+
+.. _styling:
+
+**********
+Styling 😎
+**********
+
+Each language in the Apache Arrow project follows its own style guides.
+
+In this section we will provide links to the existing documentation
+to make it easier for you to find the relevant information about
+linters and styling of the code.
+
+.. tabs::
+
+ .. tab:: PyArrow
+
+ To checking styling issues in Python files we use the
+ :ref:`Archery utility<archery>` tool developed within Apache
+ Arrow to ease some of the development tasks.
Review comment:
Great, will do!
--
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