Skip to content

Commit

Permalink
Specify that it's okay for formal names to be PascalCase as well in t…
Browse files Browse the repository at this point in the history
…he Standard Module Style guide (#25377)

[reviewed by @jabraham17]

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

Pointed out by Brad when I merged the previous style guide PR.

Double checked the built docs
  • Loading branch information
lydia-duncan authored Jun 27, 2024
2 parents 953181f + 2b978b0 commit efd1b57
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions doc/rst/developer/bestPractices/StandardModuleStyle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand Down

0 comments on commit efd1b57

Please sign in to comment.