[Webkit-unassigned] [Bug 128422] Web Inspector: update check-webkit-style to flag single quotes in WebInspectorUI projects

[bugzilla-daemon at webkit.org]

https://bugs.webkit.org/show_bug.cgi?id=128422





--- Comment #7 from Joseph Pecoraro <joepeck at webkit.org>  2014-02-17 17:59:32 PST ---
(In reply to comment #6)
> (In reply to comment #5)
> > Nit: You can just use python "# foo" comment syntax here. Unless there is an advantage to the """....""" syntax that I don't know about. These just look like generic inline comments.
> 
> Convention is to use triple-quote comments for docstrings:
> http://en.wikibooks.org/wiki/Python_Programming/Source_Documentation_and_Comments#Documentation_Strings

To quote the documentation:

> Fortunately, Python has such a capability. Documentation strings (or docstrings)
> are used to create easily-accessible documentation. You can add a docstring to a
> function, class, or module by adding a string as the first indented statement.

In these cases it is never the first indented line statement. Hence my confusion on why the syntax is being used.

-- 
Configure bugmail: https://bugs.webkit.org/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are the assignee for the bug.