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/03/04 12:39:03 UTC
[GitHub] [arrow] jorisvandenbossche commented on a change in pull request #12392: ARROW-15350: [Doc][Guide] Add styling and linters info section
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