Why is "Returns" being changed into "Return" everywhere?

        def webKitVersionString(self):
-               """ Returns the WebKit version as a printable string. """
+               """Return the WebKit version as a printable string."""

I got the Returns style from NeXTstep (now Mac OS X). Think of it this
way: Q: "What does foo() do?" A: "It returns a blah." or "foo()
returns a blah."  Try the singular version: "foo() return blah."

And it was important to add a spaces around comparison operators??

This isn't life and death stuff, but it does look like peeing all over
the code to make it smell like yours. Should I pee back?  :-)

But my biggest concern is that if we're going to cut 0.9.1 final off
the trunk, we now have tons of changes. So many that reviewing them is
painful. A print preview of the checkin email is 56 pages. Some of the
diffs span large contiguous blocks, making it hard to see at a glance
what was changed.

If this stuff goes into 0.9.1 then we'll need an rc2.


-Chuck


On 11/3/05, [EMAIL PROTECTED] <[EMAIL PROTECTED]> wrote:
> Author: chrisz
> Date: Thu Nov  3 07:46:41 2005
> New Revision: 3586
>
> Modified:
>    Webware/trunk/MiddleKit/Run/ObjectStore.py
>    Webware/trunk/MiscUtils/Funcs.py
>    Webware/trunk/MiscUtils/PickleRPC.py
>    Webware/trunk/PSP/ParseEventHandler.py
>    Webware/trunk/WebKit/Adapters/Adapter.py
>    Webware/trunk/WebKit/Adapters/HTTPAdapter.py
>    Webware/trunk/WebKit/AppServer.py
>    Webware/trunk/WebKit/Application.py
>    Webware/trunk/WebKit/Cookie.py
>    Webware/trunk/WebKit/Experimental/NewPage.py
>    Webware/trunk/WebKit/Tasks/__init__.py
>    Webware/trunk/WebKit/WebwarePathLocation.py
>    Webware/trunk/WebUtils/FieldStorage.py
>    Webware/trunk/bin/checksrc.py
> Log:
> Comment clean-up to fit the style guide.
>
> Modified: Webware/trunk/MiddleKit/Run/ObjectStore.py
> ==============================================================================
> --- Webware/trunk/MiddleKit/Run/ObjectStore.py  (original)
> +++ Webware/trunk/MiddleKit/Run/ObjectStore.py  Thu Nov  3 07:46:41 2005
> @@ -398,7 +398,7 @@
>                 If you subclass MiddleObject, then you're taken care of.
>                 """
>                 self.willChange()
> -               self._changedObjects[object] = object  ## @@ 2000-10-06 ce: 
> Should this be keyed by the object.key()? Does it matter?
> +               self._changedObjects[object] = object  # @@ 2000-10-06 ce: 
> Should this be keyed by the object.key()? Does it matter?
>
>
>         ## Serial numbers ##
snip


-------------------------------------------------------
SF.Net email is sponsored by:
Tame your development challenges with Apache's Geronimo App Server. Download
it for free - -and be entered to win a 42" plasma tv or your very own
Sony(tm)PSP.  Click here to play: http://sourceforge.net/geronimo.php
_______________________________________________
Webware-devel mailing list
Webware-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/webware-devel

Reply via email to