Skip to content

Commit

Permalink
use links
Browse files Browse the repository at this point in the history
  • Loading branch information
@cecille
cecille committed Oct 30, 2024
1 parent 850870c commit 8e0a796
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions docs/style/CODING_STYLE_GUIDE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,15 +62,22 @@ be removed.

We use the following auto-formatters on code:

| Language | Formatter | Style File |
| ---------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| C++ | clang-format | [.clang-format](https://github.com/project-chip/connectedhomeip/blob/master/.clang-format) |
| ObjectiveC | clang-format | [.clang-format](https://github.com/project-chip/connectedhomeip/blob/master/.clang-format) |
| java | google-java-format | N/A |
| Python | pep8, isort, ruff | [.restyled.yaml](https://github.com/project-chip/connectedhomeip/blob/master/.restyled.yaml) (command line),[isort](https://github.com/project-chip/connectedhomeip/blob/master/.isort.cfg) [ruff](https://github.com/project-chip/connectedhomeip/blob/master/ruff.toml) |
| YAML | prettier | None |
| JSON | prettier | None |
| markdown | prettier | None |
| Language | Formatter | Style File |
| ---------- | ------------------ | ------------------------------------------------------------------------------------------ |
| C++ | clang-format | [.clang-format](https://github.com/project-chip/connectedhomeip/blob/master/.clang-format) |
| ObjectiveC | clang-format | [.clang-format](https://github.com/project-chip/connectedhomeip/blob/master/.clang-format) |
| java | google-java-format | N/A |
| Python | pep8, isort, ruff | [.restyled.yaml][restyle_link] (command line), [isort][isort_link], [ruff][ruff_link] |
| YAML | prettier | None |
| JSON | prettier | None |
| markdown | prettier | None |

[restyle_link]:
https://github.com/project-chip/connectedhomeip/blob/master/.restyled.yaml
[isort_link]:
https://github.com/project-chip/connectedhomeip/blob/master/.isort.cfg
[ruff_link]:
https://github.com/project-chip/connectedhomeip/blob/master/ruff.toml

All pull requests run formatting checks using these tools before merge is
allowed. Generated code is not run through restyle.
Expand Down

0 comments on commit 8e0a796

Please sign in to comment.