Re: Cool URIs don't change - what should we do when removing andrenamingpages?

"Christoph M. Becker" <[email protected]>
Newsgroups gmane.comp.php.documentation.general
Message-ID <[email protected]>
On 19.04.2021 at 15:10, Rowan Tommins wrote:

> On 19/04/2021 11:48, Christoph M. Becker wrote:
>
>> Regarding the notes: as I understand it, these should generally not
>> persist for a long time.  Either they are useful, and then should be
>> integrated into the manual proper, or they are not useful, and then
>> should be deleted.  Maybe this is an opportunity to walk through the
>> respective notes?
>
> Yes, I went back and forth on this in my head a few times, and wasn't
> sure how many pages were affected. If it is just the Soap classes, a
> manual audit is probably reasonable.
>
> The SoapClient constructor was a particular magnet for notes because it
> takes a long list of options, most of which were barely documented at
> all. I've started rewriting the page to list all the options in a full
> table, and hope to then go through the notes (which are still accessible
> on main.php.net) and mark most of them as redundant.

Thanks, that's very welcome!  Consider to use a <variablelist> instead
of a table, though, since tables have the issue to easily overflow in
the manual when rendered with PhD.  Example usages of <variablelist> can
be seen on any function page, since the parameters are marked up as
such.  Nesting of <variablelist>s is properly supported by PhD.

Cheers,
Christoph
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.