Re: [PATCH v2] docs: Convert the Speakup guide to rst

From: Samuel Thibault
Date: Tue Jun 01 2021 - 17:58:49 EST


Jani Nikula, le mar. 01 juin 2021 18:51:49 +0300, a ecrit:
> On Tue, 01 Jun 2021, Igor Torrente <igormtorrente@xxxxxxxxx> wrote:
> > There's a way to do that without these blank lines?
> >
> > For me, it doesn't look very good, but I think the tradeoff worth it
> > improves readability to speakup users. If it is the case.
>
> I was thinking:
>
> acntsa
> Accent SA
>
> acntpc
> Accent PC
>
> apollo
> Apollo

Having the two pieces on separate lines makes it a bit more tedious to
read on Braille displays, it's better to keep them single-line.

> >>> +
> >>> +.. note::
> >>> +
> >>> + | Speakup does **NOT** support usb connections!
> >>> + | Speakup also does **NOT** support the internal Tripletalk!
> >>
> >> Why the pipes "|"?
> >
> > This is the way I found to separate these sentences into two different
> > lines. I'm gladly accepting a better solution for this :)
>
> Maybe just like this?
>
> .. note::
>
> Speakup does **NOT** support usb connections!
>
> Speakup also does **NOT** support the internal Tripletalk!

That will be fine (though the first statement is actually outdated)

Samuel