Skip to content

Update the Code Style Guide section to match the .clang-format tool decisions #133

@jhlegarreta

Description

@jhlegarreta

Since the merge of PR 1191 to the ITK repository, code formatting has been automatized with .clang-format.

A number of decisions were made based on the answers on the corresponding discourse post to define the style.

Thus, the Coding Style Guide section should be adapted to the adoption of the tool.

Maintaining both may be difficult as it has been until now when some change is introduced in the style. Although it is the .clang-format tool that will ultimately dictate the style in an automatic fashion, explaining the result it produces as the code layout with real examples may be useful to contributors.

Thus, there would be at least two possibilities to update the fiel/section:

  • Remove most of the contents of the file since ultimately .clang-format will take care of the formatting and explain how .clang-format takes care of the style.
  • Mention that the style is automated by the .clang-format tool, but re-work the current sections with examples to match what the .clang-format file dictates.

Also, the .clang-format tool dictates the C++ style, so for the Python ITKExamples we would still be missing a similar tool and/or a section in the ITK SW Guide (see issue #118).

Metadata

Metadata

Assignees

No one assigned

    Labels

    type:EnhancementImprovement of existing methods or implementation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions