Bug 55272 - Add style guidelines about comments from the unwritten rules email.
Summary: Add style guidelines about comments from the unwritten rules email.
Status: RESOLVED FIXED
Alias: None
Product: WebKit
Classification: Unclassified
Component: WebKit Website (show other bugs)
Version: 528+ (Nightly build)
Hardware: All All
: P2 Normal
Assignee: David Levin
URL:
Keywords:
Depends on:
Blocks: 55253 55271
  Show dependency treegraph
 
Reported: 2011-02-25 15:44 PST by David Levin
Modified: 2011-02-27 09:01 PST (History)
5 users (show)

See Also:


Attachments
Patch (2.30 KB, patch)
2011-02-25 15:54 PST, David Levin
no flags Details | Formatted Diff | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description David Levin 2011-02-25 15:44:18 PST
See https://lists.webkit.org/pipermail/webkit-dev/2009-September/009807.html (but be careful about the replies and the last changes done).
Comment 1 David Levin 2011-02-25 15:49:51 PST
These changes address this part of the email:


Usually, comments should look like sentences by beginning with a capital and
ending with a period (punctation). One exception may be end of line comments
like this "if (x == y) // false for NaN".There should be a *single* space
after punctation and before the next sentence.

There should only be a single space before end of line comments.

Use FIXME: to denote items that need to be addressed in the future.
Comment 2 David Levin 2011-02-25 15:54:52 PST
Created attachment 83894 [details]
Patch
Comment 3 WebKit Commit Bot 2011-02-26 06:45:26 PST
Comment on attachment 83894 [details]
Patch

Clearing flags on attachment: 83894

Committed r79785: <http://trac.webkit.org/changeset/79785>
Comment 4 WebKit Commit Bot 2011-02-26 06:45:31 PST
All reviewed patches have been landed.  Closing bug.
Comment 5 WebKit Review Bot 2011-02-27 09:01:49 PST
http://trac.webkit.org/changeset/79785 might have broken GTK Linux 32-bit Debug