From 3c5de19c9737c5cdaf8c717c5d4d993f2b6c5506 Mon Sep 17 00:00:00 2001 From: Wei Jiangang Date: Thu, 10 Dec 2015 10:03:20 +0800 Subject: [PATCH] Fix typos in CODING_STYLE and README s/describle/describe s/Readbility/Readability s/indepentently/independently --- CODING_STYLE | 4 ++-- README.rst | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/CODING_STYLE b/CODING_STYLE index 81325786..2fc5d049 100644 --- a/CODING_STYLE +++ b/CODING_STYLE @@ -94,7 +94,7 @@ Comments Generally, you want your comments to tell WHAT your code does, not HOW. We can figure out how from the code itself (or if not, your code needs fixing). -Try to describle the intent of a function and what it does in a triple-quoted +Try to describe the intent of a function and what it does in a triple-quoted (multiline) string just after the def line. We've tried to do that in most places, though undoubtedly we're not perfect. A high level overview is incredibly helpful in understanding code. @@ -156,7 +156,7 @@ Simple code Keep it simple; this is not the right place to show how smart you are. We have plenty of system failures to deal with without having to spend ages -figuring out your code, thanks ;-) Readbility, readability, readability. +figuring out your code, thanks ;-) Readability, readability, readability. I really don't care if other things are more compact. "Debugging is twice as hard as writing the code in the first place. Therefore, diff --git a/README.rst b/README.rst index 9833cc6e..9f6cadb9 100644 --- a/README.rst +++ b/README.rst @@ -46,4 +46,4 @@ using virt test, and commit your changes. 7) Push your changes and submit a pull request 8) That's it. -[1] You can always create your own test provider, if you have special purposes, or just want to develop your work indepentently. +[1] You can always create your own test provider, if you have special purposes, or just want to develop your work independently. -- GitLab