Re: Small change in doc snarf output

[Michael Livshin]

Neil Jerram <address@hidden> writes:

> I just noticed a small change in the doc snarfer output, in the way
> that it denotes multiple optional args.
> 
> For example, the doc for `string-index' used to begin:
> 
>   - primitive: string-index str chr [frm [to]]
> 
> and now begins:
> 
>   - primitive: string-index str chr [frm to]
> 
> Personally, I prefer how it used to be.  (It appeals to my theoretical
> side.)
> 
> So, was this change intentional, and what does everyone else prefer?

no, not intentional.  I have no preference, really, but:

* the [frm [to]] thing has a more "cluttered" look.

* [frm [to]] sort of looks like saying that `string-index''s contract
  specifies that even if `frm' is provided, `to' is still optional.
  this happens to be true in this particular function's case, but is
  still a guess (but then I may be alone in seeing it this way).

there's no problem whatsoever to change the snarfer behaviour, of
course, so if everybody prefers the old way I'll reinstate it.

-- 
Politics is non-euclidean.                           -- Robert Anton Wilson