From 58a1a14f8cec515f15a4d3a3196d6c5962a02362 Mon Sep 17 00:00:00 2001 From: Hafid Feghouli Date: Sun, 14 Oct 2018 12:17:46 -0400 Subject: [PATCH] Improved readability (#18491) Added a space after a dot "." after the sentence "for a particular programming language" and inserted a blank line after "to debug effectively." to make some breathing space. --- client/src/pages/guide/english/documentation/index.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/client/src/pages/guide/english/documentation/index.md b/client/src/pages/guide/english/documentation/index.md index 3957358996..6872dfce36 100644 --- a/client/src/pages/guide/english/documentation/index.md +++ b/client/src/pages/guide/english/documentation/index.md @@ -3,7 +3,9 @@ title: Code documentation --- ## Code Documentation -Code documentation is a way developers write their code to create the best versions of their functions possible. Code Documentations lets the newbie to get comfortable with the custom of the particular module, function etc for a particular programming language.It is always recommended to go with the Documentation before debugging your code, this helps you to debug effectively.For example, you should be able to pass along your code to an absolute beginner and they should be able to follow along through comments, appropriate variable names and structuring code in a spaced, readable manner. +Code documentation is a way developers write their code to create the best versions of their functions possible. Code Documentations lets the newbie to get comfortable with the custom of the particular module, function etc for a particular programming language. It is always recommended to go with the Documentation before debugging your code, this helps you to debug effectively. + +For example, you should be able to pass along your code to an absolute beginner and they should be able to follow along through comments, appropriate variable names and structuring code in a spaced, readable manner. It may become an extremely important idea to make a habit out of commenting your functions, loops, and declarations and treating comments as a part of the source code, just as regular code should be.