Update Coding style documentation #36275
Merged
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
- removed most of the motivation sections as it was somewhat repetitive and made the doc quite verbose - removed the drawing because it doesn't match the SDK implementation in reality - removed C discussion - I don't think we have any - added python versions. Didn't add the other languages because I dont' know but other folks can easily add a follow up - added sections on + formatters + anonymous namespaces for internal stuff in cpp files + singletons + std containers to heap allocation sections + CopySpanToMutableSpan + std::optional + python section - removed the code samples from heap allocation because it implies that people show re-implement these things when the preference is to use the provided support classes - removed the version table - we have git history.
|
Review changes with |
github-actions
bot
added
the
documentation
|
PR #36275: Size comparison from 813c245 to 6e49e9f Full report (68 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
arkq
approved these changes
Oct 29, 2024
|
PR #36275: Size comparison from 813c245 to 585534f Full report (68 builds for bl602, bl702, bl702l, cc13x4_26x4, cc32xx, cyw30739, efr32, esp32, linux, nrfconnect, nxp, psoc6, qpg, stm32, telink, tizen)
|
andy31415
approved these changes
Oct 29, 2024
arkq
reviewed
Oct 30, 2024
bzbarsky-apple
approved these changes
Oct 30, 2024
cecille
commented
Nov 14, 2024
Co-authored-by: Boris Zbarsky <[email protected]>
Alami-Amine
reviewed
Nov 15, 2024
jmartinez-silabs
approved these changes
Nov 15, 2024
Alami-Amine
approved these changes
Nov 18, 2024
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.
Also changed from adoc to md, since that's why it was not showing up on the documentation site.