From 92ee3e71007749d50d8022fd9b73bef793da676b Mon Sep 17 00:00:00 2001 From: brson Date: Fri, 26 Apr 2013 21:17:59 -0700 Subject: [PATCH] Updated Note style guide (markdown) --- Note-style-guide.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/Note-style-guide.md b/Note-style-guide.md index 12b6bd1..189e6f5 100644 --- a/Note-style-guide.md +++ b/Note-style-guide.md @@ -126,10 +126,13 @@ match foo { Prefer line comments and avoid block comments. Reason: it avoids the debate about whether to put stars on every line, etc. +In doc comments, write sentences that begin with capital letters and end in a period, even in the +short summary description. + Favor outer doc comments ``` -/// Function documentation +/// Function documentation. fn foo() { ... } @@ -149,8 +152,6 @@ Use full sentences that start with capitals and end with a period. See [[Doc-usi Put types first, then implementations -Do we want to prefer 'top-down' organization? - # Function definitions TODO @@ -195,3 +196,6 @@ Examples: A ```for``` loop is always preferable to a ```while``` loop unless the loop counts in a non-uniform way (making it difficult to express as a ```for```). +# Questions + +* Do we want to prefer 'top-down' organization? \ No newline at end of file