From 2b978b0677d1fd66a34f2f3522f52339470459ab Mon Sep 17 00:00:00 2001 From: Lydia Duncan Date: Thu, 27 Jun 2024 13:00:24 -0700 Subject: [PATCH] Specify that it's okay for formal names to be PascalCase as well This was in the original wording but I wasn't sure why it was there because I didn't recall any discussion about it. But there also wasn't discussion that they had to be camelCase only, either, just that we don't want snake_case at all. So restore the wording allowing PascalCase to those names ---- Signed-off-by: Lydia Duncan --- doc/rst/developer/bestPractices/StandardModuleStyle.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/rst/developer/bestPractices/StandardModuleStyle.rst b/doc/rst/developer/bestPractices/StandardModuleStyle.rst index 16511675c650..c8b73d8fcc30 100644 --- a/doc/rst/developer/bestPractices/StandardModuleStyle.rst +++ b/doc/rst/developer/bestPractices/StandardModuleStyle.rst @@ -138,10 +138,10 @@ Methods that are not accessors are still allowed to use "get" in their name. Formals +++++++ -Formal names should be camelCase. Descriptive names are recommended, within -reason. Encoding the type name into a formal name is generally avoided when -multiple types are supported, as doing so makes it harder to support generic -functions. +Formal names should be camelCase or PascalCase. Descriptive names are +recommended, within reason. Encoding the type name into a formal name is +generally avoided when multiple types are supported, as doing so makes it harder +to support generic functions. Some commonly used names are: