Re: [gobo-eiffel-develop] Serializer example

[Eric B. <er...@go...>]

Colin Paul Adams wrote:
>>>>>> "Eric" == Eric Bezault <er...@go...> writes:
> 
>     Eric> Hi Colin, Would it be possible that you add a Readme.txt
>     Eric> file in your serializer example explaining what it is and
>     Eric> how to use it? All examples should come with a Readme file.
> 
> It's not really finished yet (although it is working), as I am still
> refactoring the XSLT serialization (and fixing bugs). I intend to
> provide documentation on the serializer as part of the XSLT
> documentation (although I will add a separate link to it from the main
> XML documentation page, to draw attention to it), and I will refer to
> the example in that, I think. 
> So the Readme.txt will probably just point to the documentation.

That's fine.

>     Eric> Also, it would be nice if you could update the test class
>     Eric> $GOBO/test/example/xml/xm_etest_serializer.e to provide some
>     Eric> input sample and check the output, as it is done in other
>     Eric> tests such as the one for the schematron or for the argument
>     Eric> library example.
> 
> What to test?  It's a general XML serializer, with many options
> affecting the way serialization is performed.

Test that this example does not crash when provided
a simple input. I've seen many Eiffel packages providing
examples which either didn't even compile or crashed
the first time they were executed. So the tests in
$GOBO/test/example are there to try to avoid that
embarrassing situation in the Gobo package.

> If it's just to check that the example compiles, then I could
> serialize <doc/> with options to specify that it comes out as <doc/>.

Why not, that's fine as long as we have a test that
compiles the example and executes it.

-- 
Eric Bezault
mailto:er...@go...
http://www.gobosoft.com