<div dir="ltr"><div class="gmail_default" style="font-size:small">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 comment isn't even present in the code). </div>
<div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">Another benefit of writing out the full sentence is it is more likely to be grammatically correct, which may help a developer for whom English is not their primary written language -- a fragment may leave out articles or prepositions that seem implicit, but convey important nuance.</div>
<div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default" style="font-size:small">I think it's a good point, and intend to pay more attention to how I write comments and docstrings.</div>
<div class="gmail_default" style="font-size:small"><br></div><div class="gmail_default"><a href="http://nedbatchelder.com/blog/201401/comments_should_be_sentences.html">http://nedbatchelder.com/blog/201401/comments_should_be_sentences.html</a><br>
</div><div class="gmail_default"><br></div><div class="gmail_default">Doug</div><div class="gmail_default"><br></div></div>