Skip to content

Commit

Permalink
Documentation: Remove redundancy in CodingStyle.md
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
kemzeb authored and linusg committed Jun 5, 2021
1 parent 65d4ac1 commit b9980ff
Showing 1 changed file with 1 addition and 2 deletions.
3 changes: 1 addition & 2 deletions Documentation/CodingStyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down

0 comments on commit b9980ff

Please sign in to comment.