kennethreitz/python-guide
1
0
Fork 0
mirror of https://github.com/kennethreitz/python-guide.git synced 2026-06-05 14:50:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix awkward wording in "Comments" section

Browse Source
This commit is contained in:
Ryan Campbell
2012-07-03 21:31:10 -06:00
parent bfeaa95aa2
commit 63a2bfc514
1 changed files with 1 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/writing/documentation.rst
+1 -1
View File
@@ -70,7 +70,7 @@ misleading for the maintainers, slow down considerably bug hunting or
refactoring, and then, when discovered wrong, they will throw suspicion on all refactoring, and then, when discovered wrong, they will throw suspicion on all
other comments in the code, regardless of their individual correctness. other comments in the code, regardless of their individual correctness.
**No need comments for perfect code...** An hypothetical perfectly readable **There's no need to comment perfect code...** An hypothetical perfectly readable
code, with a crystal clear logic stream, expressive variable and function code, with a crystal clear logic stream, expressive variable and function
names, orthogonal segmentation passing exactly between the flesh and the bones, names, orthogonal segmentation passing exactly between the flesh and the bones,
and no implicit assumptions of any kind, would not require any comment at all. and no implicit assumptions of any kind, would not require any comment at all.