diff --git a/1. Comments and Documentation.md b/1. Comments and Documentation.md index 18d9020..c21b131 100644 --- a/1. Comments and Documentation.md +++ b/1. Comments and Documentation.md @@ -42,5 +42,3 @@ Methods that have code that is not accessible at dev-time, or perform a complex - Incomes - Outcomes - Side Effects - - diff --git a/2. Classes and Interfaces.md b/2. Classes and Interfaces.md index 1e8338d..8750aa0 100644 --- a/2. Classes and Interfaces.md +++ b/2. Classes and Interfaces.md @@ -240,7 +240,3 @@ public class Student var student = new Student (name: "Elbek", id: Guid.NewGuid()); ``` - - - - diff --git a/4. Methods.md b/4. Methods.md index f9c3de3..eb809ee 100644 --- a/4. Methods.md +++ b/4. Methods.md @@ -1,7 +1,7 @@ ## 1 Methods ### 1.0 Naming -Method names should be a summary of what the method is doing, it needs to stay percise and short and representative of the operation with respect to synchrony. +Method names should be a summary of what the method is doing, it needs to stay precise and short and representative of the operation with respect to synchrony. #### 1.0.0 Verbs Method names must contain verbs in them to represent the action it performs. @@ -276,7 +276,7 @@ public async ValueTask> GetStudentsAsync() A method declaration should not be longer than 120 characters. ##### Do ```cs -public async ValueTask> GetAllRegisteredWashgintonSchoolsStudentsAsync( +public async ValueTask> GetAllRegisteredWashingtonSchoolsStudentsAsync( StudentsQuery studentsQuery) { ... @@ -285,7 +285,7 @@ public async ValueTask> GetAllRegisteredWashgintonSchoolsStudentsA ##### Don't ```cs -public async ValueTask> GetAllRegisteredWashgintonSchoolsStudentsAsync(StudentsQuery studentsQuery) +public async ValueTask> GetAllRegisteredWashingtonSchoolsStudentsAsync(StudentsQuery studentsQuery) { ... } diff --git a/5. Variables.md b/5. Variables.md index 4fd4113..3990f56 100644 --- a/5. Variables.md +++ b/5. Variables.md @@ -56,7 +56,7 @@ var studentObj = new Student();
#### 0.0.3 Nulls or Defaults -If a variable value is it's default such as ```0``` for ```int``` or ```null``` for strings and you are not planning on changing that value (for testing purposes for instance) then the name should identify that value. +If a variable value is it's default such as ```0``` for ```int``` or ```null``` for strings and you are not planning on changing that value (for testing purposes for instance) then the name should identify that value. ##### Do ```cs Student noStudent = null; @@ -116,7 +116,7 @@ var student = new #### 0.1.3 Single-Property Types -Assign properties directly if you are declaring a type with one property. +Assign properties directly if you are declaring a type with one property. #### Do