[rabbitmq-discuss] Improving our documentation

Jiri Krutil jiri at krutil.com
Mon Nov 22 21:30:06 GMT 2010


Michael,

I think it looks much better now.

Btw, I guess the finally block in Recv won't get executed unless an 
exception is thrown -- that means no clean shutdown is possible. But I 
guess that's OK for a hello-world app.

Regards
Jiri

> Jiri, thanks for your comments --
>
> How's http://github.com/rabbitmq/rabbitmq-tutorials/tree/master/java 
> now?  I'll update the tutorial text too.
>
>> Regarding the Java examples, in my opinion the following is a bit 
>> unusual:
>>
>> - Java classes usually start with an uppercase letter.
>
> I thought I'd get away with that one ..
>
>> - Connection.close() should be probably called from a finally block.
>
> This is a bit awkward, because (as it sends frames over the 
> connection) Connection.close() can throw an IOException.  We may clean 
> this up a bit by providing a closeQuietly().
>
>> - Should recv.java really have an infinite loop?
>
> It doesn't hurt, in our "Hello World" -- the nextDelivery() blocks.
>
>> - When handling an exception, one should print all the available info
>> before swallowing it - for example using e.printStackTrace().
>
> Yes you're right, that is more idiomatic (and helpful).
>
> Cheers,
> Michael
>
>
>>> Back in October, Marek announced that we had started work on some
>>> beginners'
>>> tutorials for RabbitMQ [1].
>>>
>>> I am very pleased to be able to let everyone know that the first "Get
>>> Started" tutorials have gone live on the RabbitMQ website today. Thank
>>> you
>>> to everyone who provided comments and feedback - please keep them 
>>> coming.
>>>
>>> The tutorials are available at:
>>> http://www.rabbitmq.com/getstarted.html
>>>
>>> This is by no means the end of the work we are doing to make our
>>> documentation better so expect to see more improvements over the coming
>>> weeks and months. If you have any ideas about what you would like to 
>>> see
>>> (or, indeed, what you wouldn't) then please let us know.
>>>
>>> Jim
>>>
>>>
>>> ______________________________________________
>>> [1]
>>> http://lists.rabbitmq.com/pipermail/rabbitmq-discuss/2010-October/009351.html 
>>>
>>>
>>>
>>
>>
>>
>> _______________________________________________
>> rabbitmq-discuss mailing list
>> rabbitmq-discuss at lists.rabbitmq.com
>> https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss
>
> _______________________________________________
> rabbitmq-discuss mailing list
> rabbitmq-discuss at lists.rabbitmq.com
> https://lists.rabbitmq.com/cgi-bin/mailman/listinfo/rabbitmq-discuss


More information about the rabbitmq-discuss mailing list