RE: SV: Regarding coding style

2008-03-08 Thread Ryan Ginstrom
> On Behalf Of Grant Edwards > I think docstrings are a great idea. What's needed is a way > to document the signature that can't get out-of-sync with > what the fucntion really expects. Like doctests? (I know, smart-ass response) Regards, Ryan Ginstrom -- http://mail.python.org/mailman/list

Re: SV: Regarding coding style

2008-03-08 Thread Grant Edwards
On 2008-03-09, Steven D'Aprano <[EMAIL PROTECTED]> wrote: > On Sat, 08 Mar 2008 21:21:48 +0100, K Viltersten wrote: > >> Coming from C++/Java camp i can't help noticing that in most cases, when >> i'm using a class written by somebody else, i don't want to see his/her >> code. I only want to know W

Re: SV: Regarding coding style

2008-03-08 Thread Grant Edwards
On 2008-03-09, K Viltersten <[EMAIL PROTECTED]> wrote: >>> /** Projects an object from 3D to 2D using >>> the method of Alexander The Great. >>> \param 3D structure to be projected >>> \returns 2D projection >>> */ >>> public Proj2D get2Dfrom3D(Proj3D param); >>> >>> The above is, to me

Re: SV: Regarding coding style

2008-03-08 Thread Steven D'Aprano
On Sat, 08 Mar 2008 21:21:48 +0100, K Viltersten wrote: > Coming from C++/Java camp i can't help noticing that in most cases, when > i'm using a class written by somebody else, i don't want to see his/her > code. I only want to know WHAT the function does (is intended to be > doing, at least). >

Re: SV: Regarding coding style

2008-03-08 Thread Grant Edwards
On 2008-03-08, K Viltersten <[EMAIL PROTECTED]> wrote: >> What I really can't stand are the pointy-haired comment blocks >> at the beginnings of C/C++ functions that do things like tell >> you the name and return type of the function and list the >> names and types of the parameters. Gee, thanks.

Re: SV: Regarding coding style

2008-03-07 Thread Grant Edwards
On 2008-03-07, K Viltersten <[EMAIL PROTECTED]> wrote: >>> Personally, I dislike double spaces after sentences, but it is >>> not wrong to put them there any more than it is wrong not to >>> put them there. >> >> You're lucky my high school typing teacher didn't hear you say >> that... > > I'm un