[RFC] testable tutorial / doctests for ui

Martin Pool mbp at sourcefrog.net
Tue Jan 31 05:31:10 GMT 2006


On 31 Jan 2006, Robert Collins <robertc at robertcollins.net> wrote:
> I see two applications for the technique:
> a) making sure the tutorial isn't stale, and ditto for the api
> documentation [Testable documentation]
> b) in bzrlib/tests/blackbox/ we have a raft of tests that are primarily
> a sequence of ui commands being checked for return code and output. I
> thin it may make sense for them to be written using this more pithy
> form.... [doctests for the ui]

Yes, good point.

> I was thinking that like with Mock objects, we can handle that..
> something like
> 
> ...
>     bzreditorresponse:
>         foo
>         bar
>     $ bzr commit
>     ...

That sounds good - ideally when converted to e.g. html the tutorial will
just somehow indicate that you put this into the file.

-- 
Martin
-------------- next part --------------
A non-text attachment was scrubbed...
Name: not available
Type: application/pgp-signature
Size: 189 bytes
Desc: Digital signature
Url : https://lists.ubuntu.com/archives/bazaar/attachments/20060131/9ebdf5fc/attachment.pgp 


More information about the bazaar mailing list