Skip to content

[docs] Update Style wrt Code Formatting #3834

Closed
@SergioRAgostinho

Description

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.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

No one assigned

    Labels

    effort: lowRough estimate of time needed to fix/implement/solvegood first issueSkills/areas of expertise needed to tackle the issuemodule: docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions