develooper Front page | perl.bootstrap | Postings from July 2000

Re: RFC draft: RFC's to use POD

Dominic Dunlop
July 31, 2000 01:52
Re: RFC draft: RFC's to use POD
Message ID:
At 16:59 -0500 2000-07-30, J. David Blackstone wrote:
>Here's a draft.  Feel free to spruce things up however anyone would
>like; I'm just using the format we saw earlier.

Fine, except I'd rather like to require a references section (even if 
its contents are simply "None") at the end, because

a) Most RFCs are going to have some relation to Perl 5, which is reasonably
    extensively documented.

b) RFCs will inevitably need to reference each other.

c) Pointing people at existing documentation ahead of time may just cut
    down noise in the discussion of the RFC (even discussion in a
    supposedly focused working group).

d) If existing documentation is to be used as a basis for Perl6
    documentation, then it  will useful to know what sections will have to
    be amended if an RFC gets to be implemented.

e) I have a feeling that the RFCs may come to have a wider audience than
    them as do the implementation (and already know their way round the
    existing documentation).  Such readers need pointers.

f) Indeed, even implementors familiar with the existing documentation are
    likely to need pointers when such matters as having open() work with
    URLs are under discussion.  (In this case, references to IETF RFCs
    and/or World Wide Web Consortium papers.)

In the case of the current RFC, the references section should point 
to perlpod man page.
Dominic Dunlop Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at | Group listing | About