#38 Add comment about pipe-mode, ^ and offset in documentation

closed
nobody
None
5
2016-12-11
2005-04-06
kgc
No

When using aspell in pipe-mode, I was a little suprised
to discover that prepending ^ to the lines, would
increase offsets with 1.

Example:
run: aspell -a
input: worgn spelling
output:
& worng 45 0: ...
input: ^worng spelling
output:
& worng 45 1: ...

It's probably not a good idea to change this now, since
app's "out there" must have adapted to this, but in the
documentation:
http://aspell.sourceforge.net/man-html/Through-A-Pipe.html#Through%20A%20Pipe
it says: "It is recommended that programmatic
interfaces prefix every data line with an uparrow to
protect themselves against future changes in Aspell."

Here it would be nice with a note stating that this
means that all offsets is increased by one. I hadn't
figured this out, since the docs also states: "a line
starting with ^ has that character removed before it is
passed to the spell-checking code"

Best regards

Kasper

Discussion

  • Kevin Atkinson

    Kevin Atkinson - 2016-12-11
    • Status: open --> closed