Path: csiph.com!usenet.pasdenom.info!gegeweb.org!usenet-fr.net!nerim.net!novso.com!news2.euro.net!newsgate.cistron.nl!newsgate.news.xs4all.nl!post.news.xs4all.nl!not-for-mail Return-Path: X-Original-To: python-list@python.org Delivered-To: python-list@mail.python.org X-Spam-Status: OK 0.010 X-Spam-Evidence: '*H*': 0.98; '*S*': 0.00; 'nicely': 0.07; 'python': 0.09; 'lawrence': 0.09; 'methods,': 0.09; 'cc:addr:python-list': 0.10; 'subject:python': 0.11; 'file,': 0.15; 'grouped': 0.16; 'programmers,': 0.16; 'received:mac.com': 0.16; 'scientists': 0.16; 'subject:their': 0.16; 'wow,': 0.16; 'martin': 0.16; 'users.': 0.16; 'wrote:': 0.17; 'documented': 0.17; 'creates': 0.18; 'code.': 0.20; "i've": 0.23; 'seems': 0.23; 'cc:no real name:2**0': 0.24; 'cc:2**1': 0.24; 'cc:addr:python.org': 0.25; 'developers': 0.26; 'am,': 0.27; 'guess': 0.27; 'lines': 0.28; 'environment': 0.29; 'url:mailman': 0.29; "i'm": 0.29; 'classes': 0.30; 'expect': 0.31; 'url:python': 0.32; 'file': 0.32; 'url:listinfo': 0.32; 'thanks': 0.34; 'received:17': 0.35; 'received:192.168.0': 0.35; 'but': 0.36; 'url:org': 0.36; 'method': 0.36; 'too': 0.36; 'charset:us-ascii': 0.36; 'far': 0.37; 'data': 0.37; 'subject:: ': 0.38; 'mark': 0.38; 'takes': 0.39; 'received:192': 0.39; 'received:192.168': 0.40; 'end': 0.40; 'url:mail': 0.40; 'think': 0.40; 'your': 0.60; 'different': 0.63; 'ever': 0.63; 'more': 0.63; 'natural': 0.65; 'detail.': 0.65; 'analysis': 0.70; 'to:addr:yahoo.co.uk': 0.84; 'numbers:': 0.91; 'thoughts,': 0.91 MIME-version: 1.0 Content-transfer-encoding: 7BIT Content-type: text/plain; CHARSET=US-ASCII X-Proofpoint-Virus-Version: vendor=fsecure engine=2.50.10432:5.7.7855,1.0.431,0.0.0000 definitions=2012-11-02_01:2012-11-01, 2012-11-02, 1970-01-01 signatures=0 X-Proofpoint-Spam-Details: rule=notspam policy=default score=0 spamscore=0 ipscore=0 suspectscore=0 phishscore=0 bulkscore=0 adultscore=0 classifier=spam adjust=0 reason=mlx scancount=1 engine=6.0.2-1203120001 definitions=main-1211020026 Subject: Re: Organisation of python classes and their methods From: Martin Hewitson In-reply-to: Date: Fri, 02 Nov 2012 09:45:43 +0100 References: <7xa9v0wj2g.fsf@ruckus.brouhaha.com> To: Mark Lawrence X-Mailer: Apple Mail (2.1499) Cc: python-list@python.org X-BeenThere: python-list@python.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: General discussion list for the Python programming language List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Newsgroups: comp.lang.python Message-ID: Lines: 30 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1351849569 news.xs4all.nl 6899 [2001:888:2000:d::a6]:34547 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:32610 On 2, Nov, 2012, at 09:40 AM, Mark Lawrence wrote: > On 02/11/2012 08:08, Martin Hewitson wrote: >> >> Even if one takes reasonable numbers: 20 methods, each method has 20 lines of documentation, then we immediately have 400 lines in the file before writing a line of code. It would seem much more natural to me to have these methods in their own file, grouped nicely in sub-directories. But it seems this is not the python way. Sigh. >> >> Thanks for your thoughts, >> >> Martin >> > > 20 lines of documentation per method? As far as I'm concerned that's not a smell, that's a stink. Wow, I don't think I've ever been criticised before for writing too much documentation :) I guess we have different end users. This is not a set of classes for other developers to use: it's a set of classes which creates a data analysis environment for scientists to use. They are not programmers, and expect the algorithms to be documented in detail. Martin > > -- > Cheers. > > Mark Lawrence. > > -- > http://mail.python.org/mailman/listinfo/python-list