瀏覽代碼

Clarify TODOs/FIXMEs in style guide

Alois Mahdal 8 年之前
父節點
當前提交
ae5a70d8fe
共有 1 個文件被更改,包括 4 次插入2 次删除
  1. 4
    2
      notes/style.md

+ 4
- 2
notes/style.md 查看文件

@@ -141,13 +141,15 @@ or this (easier when another line is added):
141 141
 
142 142
 ### TODOs, FIXMEs, workarounds ###
143 143
 
144
-These must be one-liners, so that they can be easily understood by grepping.
144
+These must be one-liners, so that they can be easily understood when
145
+grepping.
145 146
 
146 147
     #TODO: Review the loop
147 148
     #FIXME: We throw away stdout due to bug in Glib
148 149
     #       http://bugs.gnome.org/bug/12345
149 150
 
150
-Exception is URL, that can span to next line.
151
+Exception is if the note is acompanied with URL, which probably would not
152
+be useful to reader, so can be moved to next line.
151 153
 
152 154
 Note that for both TODOs and FIXMEs, it's always better to have a tracker
153 155
 that is referenced in place--that's especially true if you can't fit the