Re: Hamster documentation review

[Bruce Cowan <lists bcowan fastmail co uk>]

On Sun, 2010-02-21 at 14:29 -0600, Paul Cutler wrote:
> On Sun, 2010-02-21 at 21:22 +0100, Milo Casagrande wrote:
> > 2010/2/21 Bruce Cowan <lists bcowan fastmail co uk>:
> > > Here's a patch that fixes a few grammar issues. I don't really know how
> > > Mallard works, so bear with me if I did anything incorrectly.
> > >
> > > I'd be happy to review any other documentation now, or in the future.
> > 
> > I've taken only a quick look at the patch, and noticed one thing: you
> > removed all the final period from the description of a topic
> > (<desc></desc>). Empathy help uses them, and also the other helps I
> > think.
> > 
> > So, what is the "standard" way to use them? I'm fine with either, but
> > I think we need to write it somewhere to avoid confusion.
> > 
> > Ciao.
> > 
> I recommend keeping the periods - the Topics should not have them, but
> the description should.  For example, from Empathy:
> 
> Favorite rooms
> Set, join and manage favorite rooms.

Yes, this was something I wasn't sure about. I suppose I should have
checked the empathy documentation beforehand.
-- 
Bruce Cowan <bcowan fastmail co uk>