ietf-nntp Sections 5 and 6

Clive D.W. Feather clive at demon.net
Tue Jul 18 08:56:26 PDT 2000


Minor nits only.

> 5. The WILDMAT format

> Implementers must be careful to apply the pattern-matching
> operators to whole characters encoded in UTF-8, and not two
> individual octets.

s/two/to/

> 5.2  Examples

Add something to reinforce the bit about UTF-8, say:

    g) ?  -- will match the two octet sequence 194 137, as this is
             a single UTF-8 character.
    h) ?? -- will not match the two octet sequence 194 137 for the
             same reason.

> 6. Format for Keyword Descriptions

> Each keyword is shown in upper case for clarity, although the
> NNTP server ignores case in the interpretation of commands.
> Any parameters are shown in lower case. [...] Unless stated
> otherwise, a parameter name in lowercase represents a token
> described elsewhere, while one in uppercase is a literal
> string that is included as written.

This is self-inconsistent. Try the following rewrite of the last two
paragraphs.

  Each keyword is shown in upper case for clarity, although the
  NNTP server ignores case in the interpretation of commands.
  Parameters are shown as follows:
  * UPPERCASE    indicates literal text to be included in the command;
  * lowercase    indicates a token described elsewhere;
  * [brackets]   indicate that the parameter is optional;
  * ellipsis...  indicates that the parameter may be repeated any
                 number of times (it must occur at least once);
  * vertical|bar indicates a choice of two mutually exclusive parameters
                 (exactly one must be provided).
  Parameters are case or language specific only when specified (either
  in this document or in RFC 1036[6]).

  The name "wildmat" for a parameter indicates that it is a wildmat
  format pattern as defined in section 5.

By the way, you are inconsistent in your use of "lowercase" v "lower case"
and of "WILDMAT format" v "wildmat format". This should be fixed throughout
the document.

-- 
Clive D.W. Feather  | Work:  <clive at demon.net>   | Tel:  +44 20 8371 1138
Internet Expert     | Home:  <clive at davros.org>  | Fax:  +44 20 8371 1037
Demon Internet      | WWW: http://www.davros.org | DFax: +44 20 8371 4037
Thus plc            |                            | Mobile: +44 7973 377646 



More information about the ietf-nntp mailing list