CODING_CONVENTIONS.md: Add preprocessor directive formatting #20866
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Note: I'm not adding an "API change" label, as this is intended to really just document what is current policy anyway, rather than changing things. It would be good to confirm that this is indeed the implicit policy now, though. |
mguetschow
reviewed
Sep 18, 2024
|
Let's give this PR a few days to gather feedback. |
miri64
added
the
Type: enhancement
|
👍 |
|
The convention described, seems to match that of the newer code that I have looked at. I agree that the convention is a logical choice. Also the wording and examples seem clear to me. I don't seem to have sufficient permission to approve, but I would if I could. |
This explicitly spells out what informally has been the coding convention for some time on preprocessor directives, making it more transparent and easier to find. This is particularly useful as the code base has at least three different styles. Deducing what actually is the current policy would require a details look at how the style has changed over time, rather than being obvious from a quick `grep` over the code base.
|
squashed |
maribu
force-pushed
the
CODING_CONVENTIONS.md/indent-pp-directives
branch
from
869b56d
to
f431aab
Compare
mguetschow
approved these changes
Sep 23, 2024
mguetschow
added
the
CI: ready for build
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Contribution description
This explicitly spells out what informally has been the coding convention for some time on preprocessor directives, making it more transparent and easier to find.
This is particularly useful as the code base has at least three different styles. Deducing what actually is the current policy would require a details look at how the style has changed over time, rather than being obvious from a quick
grepover the code base.Testing procedure
Check that the wording is clear and easy to understand and that the policy matches what we actually do. (E.g. look at ztimer, as this is a rather new component that has received lots of reviewing.)
Issues/PRs references
#20864 (comment)