Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.python > #59517

Re: understanding someone else's program

Path csiph.com!usenet.pasdenom.info!aioe.org!news.stack.nl!newsfeed.xs4all.nl!newsfeed2.news.xs4all.nl!xs4all!post.news.xs4all.nl!not-for-mail
Return-Path <prvs=024e16d14=jeanmichel@sequans.com>
X-Original-To python-list@python.org
Delivered-To python-list@mail.python.org
X-Spam-Status OK 0.143
X-Spam-Level *
X-Spam-Evidence '*H*': 0.72; '*S*': 0.01; 'parameters': 0.04; 'cc:addr:python-list': 0.11; 'suggest': 0.14; 'subject:program': 0.16; 'subject:skip:u 10': 0.16; 'code.': 0.18; 'variable': 0.18; 'all,': 0.19; 'thanks.': 0.20; 'cc:addr:python.org': 0.22; 'stick': 0.24; 'cc:2**0': 0.24; 'cc:no real name:2**0': 0.24; 'certain': 0.27; 'values': 0.27; 'header:In-Reply-To:1': 0.27; 'function': 0.29; 'code': 0.31; 'doc': 0.31; 'trace': 0.31; 'with,': 0.31; '-----': 0.33; 'there': 0.35; 'thank': 0.38; 'how': 0.40; 'is.': 0.60; 'you.': 0.62; 'making': 0.63; 'information': 0.63; 'received:194': 0.64; 'to:addr:gmail.com': 0.65; 'notice:': 0.67; 'person,': 0.68; 'privileged.': 0.69; 'disclose': 0.74; 'yourself': 0.78; "else's": 0.84; 'subject:else': 0.84; 'medium.': 0.91
X-IronPort-AV E=Sophos;i="4.93,708,1378850400"; d="scan'208";a="2123445"
X-Virus-Scanned amavisd-new at zimbra.sequans.com
Date Fri, 15 Nov 2013 14:49:01 +0100 (CET)
From Jean-Michel Pichavant <jeanmichel@sequans.com>
To "C. Ng" <ngcbmy@gmail.com>
In-Reply-To <19cb1c85-1c01-4c53-a26a-29f96c5926eb@googlegroups.com>
Subject Re: understanding someone else's program
MIME-Version 1.0
X-Mailer Zimbra 7.2.4_GA_2900 (ZimbraWebClient - GC30 (Win)/7.2.4_GA_2900)
Content-Type text/plain; charset="utf-8"
Content-Transfer-Encoding base64
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 <python-list.python.org>
List-Unsubscribe <https://mail.python.org/mailman/options/python-list>, <mailto:python-list-request@python.org?subject=unsubscribe>
List-Archive <http://mail.python.org/pipermail/python-list/>
List-Post <mailto:python-list@python.org>
List-Help <mailto:python-list-request@python.org?subject=help>
List-Subscribe <https://mail.python.org/mailman/listinfo/python-list>, <mailto:python-list-request@python.org?subject=subscribe>
Newsgroups comp.lang.python
Message-ID <mailman.2651.1384523350.18130.python-list@python.org> (permalink)
Lines 20
NNTP-Posting-Host 2001:888:2000:d::a6
X-Trace 1384523350 news.xs4all.nl 15890 [2001:888:2000:d::a6]:60513
X-Complaints-To abuse@xs4all.nl
Xref csiph.com comp.lang.python:59517

Show key headers only | View raw

----- Original Message -----
> Hi all,
> 
> Please suggest how I can understand someone else's program where
> - documentation is sparse
> - in function A, there will be calls to function B, C, D.... and in
> those functions will be calls to functions R,S,T.... and so on so
> forth... making it difficult to trace what happens to a certain
> variable
> 
> Am using ERIC4 IDE.
> 
> Thanks.

If the documentation is sparse, writing the doc yourself is one way to dive into someone else's code. To begin with, you can stick to the function purpose, and for the WTF functions try to document the parameters and return values as well.

It may take a lot of time depending on how good the current code is.

JM


-- IMPORTANT NOTICE: 

The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium. Thank you.

Back to comp.lang.python | Previous | Next | Find similar | Unroll thread

Thread

Re: understanding someone else's program Jean-Michel Pichavant <jeanmichel@sequans.com> - 2013-11-15 14:49 +0100

csiph-web