From 6556062eaa8c3387b170511a8758125748d1df24 Mon Sep 17 00:00:00 2001 From: Damir Shamanaev Date: Wed, 15 Nov 2023 15:13:32 +0300 Subject: [PATCH] minor patch to conventions --- language/documentation/book/src/coding-conventions.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/language/documentation/book/src/coding-conventions.md b/language/documentation/book/src/coding-conventions.md index caea845e41..1836505224 100644 --- a/language/documentation/book/src/coding-conventions.md +++ b/language/documentation/book/src/coding-conventions.md @@ -10,7 +10,7 @@ This section lays out some basic coding conventions for Move that the Move team - **Constant names**: should be upper camel case and begin with an `E` if they represent error codes (e.g., `EIndexOutOfBounds`) and upper snake case if they represent a non-error value (e.g., `MIN_STAKE`). - - **Generic type names**: should be descriptive, or anti-descriptive where appropriate, e.g., `T` or `Element` for the Vector generic type parameter. Most of the time the "main" type in a module should be the same name as the module e.g., `option::Option`, `fixed_point32::FixedPoint32`. -- **Module file names**: should be the same as the module name e.g., `Option.move`. +- **Module file names**: should be the same as the module name e.g., for `std::option` use `option.move`. - **Script file names**: should be lower snake case and should match the name of the “main” function in the script. - **Mixed file names**: If the file contains multiple modules and/or scripts, the file name should be lower snake case, where the name does not match any particular module/script inside.