Skip to content

Commit 0a0cfa2

Browse files
authored
htmlcssguide: Update TODO format (#884)
This update changes the TODO formatting and examples to more closely align with Google’s internal TODO style.
1 parent b5908c3 commit 0a0cfa2

File tree

1 file changed

+4
-6
lines changed

1 file changed

+4
-6
lines changed

htmlcssguide.html

+4-6
Original file line numberDiff line numberDiff line change
@@ -143,16 +143,14 @@ <h4 id="Action_Items" class="numbered">Action Items</h4>
143143
<p>Highlight todos by using the keyword <code>TODO</code> only, not other common formats like
144144
<code>@@</code>.</p>
145145

146-
<p>Append a contact (username or mailing list) in parentheses as with the format
147-
<code>TODO(contact)</code>.</p>
146+
<p>Append action items after a colon as in <code>TODO: action
147+
item</code>.</p>
148148

149-
<p>Append action items after a colon as in <code>TODO: action item</code>.</p>
150-
151-
<pre><code class="language-django external good">{# TODO(john.doe): revisit centering #}
149+
<pre><code class="language-django external good">{# TODO: Revisit centering. #}
152150
&lt;center&gt;Test&lt;/center&gt;
153151
</code></pre>
154152

155-
<pre><code class="language-html good">&lt;!-- TODO: remove optional tags --&gt;
153+
<pre><code class="language-html good">&lt;!-- TODO: Remove optional tags. --&gt;
156154
&lt;ul&gt;
157155
&lt;li&gt;Apples&lt;/li&gt;
158156
&lt;li&gt;Oranges&lt;/li&gt;

0 commit comments

Comments
 (0)