Pcl: [docs] Update Style wrt Code Formatting

Created on 31 Mar 2020  路  5Comments  路  Source: PointCloudLibrary/pcl

The following section of the style guide needs to be updated

https://github.com/PointCloudLibrary/pcl/blame/master/doc/advanced/content/pcl_style_guide.rst#L317-L377

Currently the code style we're enforcing is with clang-format, whose config file is also picked up by most IDEs. The remaining style files which were previously distributed should be considered deprecated and not distributed anymore.

Currently, to format code, most IDEs parse clang-format files (ours is here). On Linux and Mac, there's always the option to run

$ make format

If clang-format is installed and detected during configuration.

low good first issue docs

All 5 comments

Should we write the documentation for various editors, IDE's?
Or the text you mentioned will suffice?

I'd start by specifying the .clang-format, what it does, a link to our .clang-format and how to use it in absence of a IDE plugin (aka running make formattwice`).

Also, remove the links to other editor specific configs, maybe link to integrations on this page

(aka running make format twice`).

What was it about running it twice? If that's always necessary, then we should probably update the make format command (or the formatting script).

What was it about running it twice?

It sometimes takes running format twice to reach stable diff, but that's not a concern on the CI, right? Any change on the CI is a sign of bad formatting

Agree regarding CI. But I think your message is the first mention of CI in this thread :)

Was this page helpful?
0 / 5 - 0 ratings