Re: [openstack-dev] writing comments as complete sentences

2014-01-21 Thread Christopher Yeoh
On Thu, Jan 16, 2014 at 5:35 AM, Renat Akhmerov rakhme...@mirantis.comwrote: I absolutely agree with that. Honestly, I don’t even understand why it can be different (not compliant with regular grammar rules). Comments are supposed to clarify things so they should be worded very clearly and

Re: [openstack-dev] writing comments as complete sentences

2014-01-15 Thread Renat Akhmerov
I absolutely agree with that. Honestly, I don’t even understand why it can be different (not compliant with regular grammar rules). Comments are supposed to clarify things so they should be worded very clearly and read as normal English sentences. Additionally it’s one of the small bricks that

[openstack-dev] writing comments as complete sentences

2014-01-14 Thread Doug Hellmann
Ned Batchelder had an interesting post a few days ago about why code comments should be written as complete sentences, rather than fragments. The main point is that with an unterminated phrase or sentence fragment it isn't always clear that the thought has been completed (i.e., maybe the full

Re: [openstack-dev] writing comments as complete sentences

2014-01-14 Thread Jay Pipes
On Tue, 2014-01-14 at 08:01 -0500, Doug Hellmann wrote: Ned Batchelder had an interesting post a few days ago about why code comments should be written as complete sentences, rather than fragments. The main point is that with an unterminated phrase or sentence fragment it isn't always clear