summaryrefslogtreecommitdiff
path: root/Documentation
diff options
context:
space:
mode:
authorkemzeb <kemalzebra@gmail.com>2021-06-03 15:27:46 -0700
committerLinus Groh <mail@linusgroh.de>2021-06-06 00:18:02 +0100
commitb9980ffd07791e9d003bf77b1f4b8577aefe321a (patch)
tree8be7783f79ae4bac48a38fd69059fd25a24dbd9c /Documentation
parent65d4ac1c14db5336b4db0c99ac4a0efeea745dc1 (diff)
downloadserenity-b9980ffd07791e9d003bf77b1f4b8577aefe321a.zip
Documentation: Remove redundancy in CodingStyle.md
This is a fairly small change; removed the statement "Pointer and reference types in C++ code" as it does not provide any additional knowledge that contributors are or will be aware of after further reading into the "Pointers and References" section. It seems unnecessary and redundant given the sentence adjacent to it.
Diffstat (limited to 'Documentation')
-rw-r--r--Documentation/CodingStyle.md3
1 files changed, 1 insertions, 2 deletions
diff --git a/Documentation/CodingStyle.md b/Documentation/CodingStyle.md
index 96f4b2601f..28c2c43b96 100644
--- a/Documentation/CodingStyle.md
+++ b/Documentation/CodingStyle.md
@@ -261,8 +261,7 @@ for (auto it = children.begin(); it != children.end(); ++it)
### Pointers and References
-[](#pointers-cpp) **Pointer and reference types in C++ code**
-Both pointer types and reference types should be written with no space between the type name and the `*` or `&`.
+[](#pointers-cpp) Both pointer types and reference types should be written with no space between the type name and the `*` or `&`.
[](#pointers-out-argument) An out argument of a function should be passed by reference except rare cases where it is optional in which case it should be passed by pointer.