Path: csiph.com!v102.xanadu-bbs.net!xanadu-bbs.net!feeder.erje.net!us.feeder.erje.net!newsfeed.xs4all.nl!newsfeed2a.news.xs4all.nl!xs4all!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.059 X-Spam-Evidence: '*H*': 0.89; '*S*': 0.00; '21,': 0.07; 'cc:addr :python-list': 0.11; 'python': 0.11; "'''": 0.16; '(without': 0.16; 'docstrings': 0.16; 'from:addr:rosuav': 0.16; 'from:name:chris angelico': 0.16; 'stuff.': 0.16; 'subject:python': 0.16; 'wrote:': 0.18; 'cc:addr:python.org': 0.22; 'tend': 0.24; 'cc:2**0': 0.24; 'header:In-Reply-To:1': 0.27; 'idea': 0.28; 'am,': 0.29; "doesn't": 0.30; 'message- id:@mail.gmail.com': 0.30; 'comments': 0.31; 'sep': 0.31; 'subject:some': 0.31; 'not.': 0.33; 'info': 0.35; 'advice': 0.35; 'something': 0.35; 'received:google.com': 0.35; 'useful': 0.36; 'should': 0.36; 'called': 0.40; 'how': 0.40; 'capital': 0.73; 'subject:!!!': 0.74; 'subject:get': 0.81; 'commenting': 0.84; 'horrible': 0.84; 'good,': 0.91; 'subject:Love': 0.91; 'to:none': 0.92 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; h=mime-version:in-reply-to:references:date:message-id:subject:from:cc :content-type; bh=8s9GuTUWUeDKRQTiQn2v1McXs10JVS/PcySgaZC0HdU=; b=HA7qRhG7Onoj4PgdqMzNDP+3/pB8sX3SkMgYCzFA6Ea820wFtQxz3HLEFVzg90I4S6 gpTUPSCDVyv8nEoqoHJdlvIJj4sbBIS554dGkNWNa9gfA9pdslYvVQUc37oLrLotRAeU bc6hbVRPV5H7vXflnnTLV5R3I5t9FmFeXbKnqDRC9FVAU2Fznh8UXXT2Ch5P1xUv8IOo 9KfsMpmKPK1isMO+7U64Voe38lLRE9yv8+RWd8wjuUaJ3OyR1j6n3jbqLFQNYpUZR58j zsGbkhN5gqf+aCJBFOooegzkBfJ95XJpjISraq3WnXAfXlZBAYcosUX1AV8V4n0PbA3H VYSA== MIME-Version: 1.0 X-Received: by 10.51.17.2 with SMTP id ga2mr6015376igd.2.1411264098297; Sat, 20 Sep 2014 18:48:18 -0700 (PDT) In-Reply-To: References: <42e68de9-7528-46fc-8c74-c0baa1d6199e@googlegroups.com> Date: Sun, 21 Sep 2014 11:48:18 +1000 Subject: Re: Love to get some feedback on my first python app!!! From: Chris Angelico Cc: "python-list@python.org" Content-Type: text/plain; charset=UTF-8 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: 12 NNTP-Posting-Host: 2001:888:2000:d::a6 X-Trace: 1411264101 news.xs4all.nl 2884 [2001:888:2000:d::a6]:40639 X-Complaints-To: abuse@xs4all.nl Xref: csiph.com comp.lang.python:78114 On Sun, Sep 21, 2014 at 11:33 AM, Nicholas Cannon wrote: > Yeah this is exactly what I was looking for I know the comments are horrible and I had no idea about the camelCase stuff. Should I use > ''' > Use this commenting on my functions or not. I think they are called docStrings or something > ''' Yes, they're called docstrings (without the capital S - again, Python doesn't tend to work that way). You can find info and advice all over the web about how to write good, useful docstrings. ChrisA