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: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
