You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jira@arrow.apache.org by "Antoine Pitrou (Jira)" <ji...@apache.org> on 2022/01/10 13:56:00 UTC

[jira] [Resolved] (ARROW-15248) [C++][Docs] Improve instructions for C++ formatting/linting

     [ https://issues.apache.org/jira/browse/ARROW-15248?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Antoine Pitrou resolved ARROW-15248.
------------------------------------
    Fix Version/s: 7.0.0
       Resolution: Fixed

Issue resolved by pull request 12085
[https://github.com/apache/arrow/pull/12085]

> [C++][Docs] Improve instructions for C++ formatting/linting
> -----------------------------------------------------------
>
>                 Key: ARROW-15248
>                 URL: https://issues.apache.org/jira/browse/ARROW-15248
>             Project: Apache Arrow
>          Issue Type: Improvement
>          Components: C++, Documentation
>            Reporter: David Li
>            Assignee: David Li
>            Priority: Major
>              Labels: pull-request-available
>             Fix For: 7.0.0
>
>          Time Spent: 2h 50m
>  Remaining Estimate: 0h
>
> [Code Style, Linting, and CI|https://arrow.apache.org/docs/developers/cpp/development.html#code-style-linting-and-ci] could use the following:
>  * clang-format is implicitly described, but should be made an explicit requirement.
>  * We should describe how to format C++ code with archery.
>  * We should describe how to format/lint C++ code with the CMake build.
>  * We should describe how Archery discovers the clang-format/cpplint executables.
>  * We should describe how to use the GitHub Actions bot to try to format code.
>  * If the wrong version of clang-format or clang-tidy is found, we should explicitly note that instead of just saying 'not found'
>  * We should clarify that the exact version of these tools is needed
>  * Link to the LLVM downloads since it may not be obvious where to get all these linter tools



--
This message was sent by Atlassian Jira
(v8.20.1#820001)