From d72cdf1b8321111d7e520dc03ba27b131c77869f Mon Sep 17 00:00:00 2001 From: Flaviu Tamas Date: Sun, 11 Jan 2015 13:34:44 -0500 Subject: [PATCH] Updated NEP 1 : Style Guide for Nim Code (markdown) --- NEP 1 : Style Guide for Nim Code.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/NEP 1 : Style Guide for Nim Code.md b/NEP 1 : Style Guide for Nim Code.md index 1d12f7f..5ba82ff 100644 --- a/NEP 1 : Style Guide for Nim Code.md +++ b/NEP 1 : Style Guide for Nim Code.md @@ -28,7 +28,7 @@ Style Guidelines - Although use of whitespace for stylistic reasons other than the ones endorsed by this guide are allowed, careful thought should be put into such practices. Not all editors support automatic alignment of code sections, and re-aligning - long sections of code by hand can quickly become tedius. + long sections of code by hand can quickly become tedious. ```nimrod # This is bad, as the next time someone comes # to edit this code block, they @@ -47,14 +47,14 @@ Style Guidelines Note: While the rules outlined below are the *current* naming conventions, these conventions have not always been in place. Previously, the naming conventions for identifiers followed the Pascal tradition of prefixes -which indicated the base type of the identifer - PFoo for pointer and reference +which indicated the base type of the identifier - PFoo for pointer and reference types, TFoo for value types, EFoo for exceptions, etc. Though this has since changed, there are many places in the standard library which still use this convention. Such style remains in place purely for legacy reasons, and will be changed in the future. - Type identifiers should be in camelCase. All other identifiers should be in - CamelCase with the exception of constants which **may** use PascalCase but + camelCase with the exception of constants which **may** use PascalCase but are not required to. ```nimrod const aConstant = 42