From 64bf069fa9095cdc001503ea9d85dd1ed4108b3e Mon Sep 17 00:00:00 2001 From: David Gillispie <44272141+Thegillie@users.noreply.github.com> Date: Sun, 4 Nov 2018 23:08:44 -0500 Subject: [PATCH] Tabs on documentation (#21071) --- guide/english/documentation/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/guide/english/documentation/index.md b/guide/english/documentation/index.md index 9e3a841e54..c7951fbf4e 100644 --- a/guide/english/documentation/index.md +++ b/guide/english/documentation/index.md @@ -11,6 +11,8 @@ It is a good idea to make a habit out of commenting your functions, loops, and d Many developers have probably learned that it is much harder to go back through your code and comment it after you finish. It's always a good idea to label and comment your code as you go, so that you don't forget or mix up what certain variables or functions do. +Think of Code documention as a history textbook. It allows current developers to keep tabs on their progress, as well as to educate future developers. Use it not only as a learning tool, but also as a reminder. As George Santayana once said, "Those who do not read history are doomed to repeat it!" + ![An example of commenting in the real world](https://cdn-images-1.medium.com/max/1620/1*Pyxsc7Uixbitv5myywaA_Q.jpeg)