caml-list - the Caml user's mailing list
 help / color / mirror / Atom feed
From: rixed@happyleptic.org
To: caml-list@inria.fr
Subject: Re: [Caml-list] Preferred layout for new packages
Date: Thu, 15 Nov 2012 10:17:39 +0100	[thread overview]
Message-ID: <20121115091739.GB26744@securactive.lan> (raw)
In-Reply-To: <20121115082443.2af5f758@xivilization.net>

-[ Thu, Nov 15, 2012 at 08:24:43AM +0100, Marek Kubica ]----
> Actually, In Python tests are not routinely written in comments.

Well, at least here where I work, the python devs are more acustomed to
doctests than external tests.  And I think it's a clever trick as it serves
both the purpose of testing and documenting a function.

Of course this is not suitable for more in-depth testing, where external tests
are required. This is what's done in batteries: short and simple tests are
written inline where they are usefull to document how to use a function (there
were discussions about inserting these inline tests in the generated
documentation !), and longuer tests comes in external files compiled
separately. 


  reply	other threads:[~2012-11-15  9:19 UTC|newest]

Thread overview: 18+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-11-14 11:43 Marek Kubica
2012-11-14 14:41 ` Török Edwin
2012-11-14 16:36   ` Marek Kubica
2012-11-15  1:20   ` Francois Berenger
2012-11-14 14:42 ` Edgar Friendly
2012-11-14 17:00   ` Marek Kubica
2012-11-14 18:00     ` forum
2012-11-15  9:00       ` Philippe Veber
2012-11-14 18:17     ` Martin Jambon
2012-11-14 18:48       ` Markus Mottl
2012-11-14 19:35         ` Martin Jambon
2012-11-15  6:36     ` Cedric Cellier
2012-11-15  7:24       ` Marek Kubica
2012-11-15  9:17         ` rixed [this message]
     [not found] <fa.38rAsBvHd+quECbtcbTH9HW+J6U@ifi.uio.no>
     [not found] ` <fa.YCrkHurCi6yY5s0Qg1r6uLWNQdY@ifi.uio.no>
     [not found]   ` <fa.oeqp0ymFFL+o76ut/LjBeQhUcjQ@ifi.uio.no>
     [not found]     ` <fa.pEDV80ILnW8x1YQyKuF3NBsK3Kw@ifi.uio.no>
     [not found]       ` <fa.LQofvqHUt8xj1kM1rvmQZF+Z7rw@ifi.uio.no>
2012-11-15  8:13         ` vincent.hugot
2012-11-15  8:31           ` Francois Berenger
2012-11-15  9:20           ` rixed
2012-11-15 17:22             ` Aleksey Nogin

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20121115091739.GB26744@securactive.lan \
    --to=rixed@happyleptic.org \
    --cc=caml-list@inria.fr \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).