Rename typedefs #17
Rename typedefs #17
Conversation
There was a problem hiding this comment.
While overall I think this is a good idea to leave _t to fundamental types, I do worry that many of the new type names can be mistaken for variable names (easy fix and easily spotted, I know).
I think that following https://google.github.io/styleguide/cppguide.html#Type_Names would be better for clarity, where all type names start with a capital letter to differentiate them from potential variable names.
There was a problem hiding this comment.
Well done, Jack! Looks great!
I will leave the final decision up to you, but I would either follow Lee's suggestion and use CamelCase type names or take a page out of the standard library and use a _type suffix (e.g., see the member types of std::vector or std::pair). Just removing the _t suffix works but may be prone to shadowing.
|
Jack, should this be changed in the README.md example (and any relevant examples in docs) as well? |
I went with Lee's suggestion in the end, I think it makes sense since Google style is closest to what we've been using thus far. |
Context:
We have decided to use camel cases for type aliases in accordance with accordance with Google style. We have also decided against the use of
_tsuffixes for aliases of non-fundamental types. The use of_tsuffixes is reserved for aliases of fundamental types (e.gNodeID_t).Description of the Change:
Changed all type aliases to camel case. Removed
_tsuffix from all aliases of non-fundamental types.Also removed type aliases from test files when they were only used once or twice.
Benefits:
Code quality, consistent style.
Possible Drawbacks:
Related GitHub Issues: