bug#18686: 25.0.50; incorrect signature in doc string of `create-fontset-from-fontset-spec'

bug#18686: 25.0.50; incorrect signature in doc string of `create-fontset-from-fontset-spec'

[Drew Adams]

(elisp) `Fontsets' makes it clear that the first arg, FONTSET-SPEC, has
a required part and possibly repeated optional parts:

  This function defines a new fontset according to the specification
  string FONTSET-SPEC.  The string should have this format:

       FONTPATTERN, [CHARSET:FONT]...

The doc string has something completely different, in which perhaps at
least one of the CHARSET:FONT parts is required (?), not optional:

  FONTSET-SPEC is a string of the format:
      FONTSET-NAME,SCRIPT-NAME0:FONT-NAME0,SCRIPT-NAME1:FONT-NAME1, ...

Well, yes, there is `...' at the end, but it is not clear what its scope
is.  Please use unambiguous notation similar to what the manual uses.

And the parts of FONTSET-SPEC are not at all specified. (They are
described in the manual, however.)


In GNU Emacs 25.0.50.1 (i686-pc-mingw32)
 of 2014-10-06 on LEG570
Bzr revision: 118063 monnier@iro.umontreal.ca-20141006174756-y7ha091r491l1ijw
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --enable-checking=yes,glyphs 'CFLAGS=-O0 -g3'
 CPPFLAGS=-DGLYPH_DEBUG=1'

bug#18686: 25.0.50; incorrect signature in doc string of `create-fontset-from-fontset-spec'

[Lars Ingebrigtsen]

Drew Adams <drew.adams@oracle.com> writes:

> (elisp) `Fontsets' makes it clear that the first arg, FONTSET-SPEC, has
> a required part and possibly repeated optional parts:
>
>   This function defines a new fontset according to the specification
>   string FONTSET-SPEC.  The string should have this format:
>
>        FONTPATTERN, [CHARSET:FONT]...
>
> The doc string has something completely different, in which perhaps at
> least one of the CHARSET:FONT parts is required (?), not optional:
>
>   FONTSET-SPEC is a string of the format:
>       FONTSET-NAME,SCRIPT-NAME0:FONT-NAME0,SCRIPT-NAME1:FONT-NAME1, ...
>
> Well, yes, there is `...' at the end, but it is not clear what its scope
> is.  Please use unambiguous notation similar to what the manual uses.

I've now fixed this.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no