Doc #66661 [Asn->Csd]: AMQP documentation is horribly wrong

From: Date: Sun, 09 Feb 2014 02:20:14 +0000
Subject: Doc #66661 [Asn->Csd]: AMQP documentation is horribly wrong
References: 1  Groups: php.doc.bugs 
Request: Send a blank email to doc-bugs+get-10967@lists.php.net to get a copy of this message
Edit report at https://bugs.php.net/bug.php?id=66661&edit=1

 ID:                 66661
 Updated by:         bjori@php.net
 Reported by:        phpbugs at rfnj dot org
 Summary:            AMQP documentation is horribly wrong
-Status:             Assigned
+Status:             Closed
 Type:               Documentation Problem
 Package:            amqp
 Operating System:   irrelevant
 PHP Version:        Irrelevant
 Assigned To:        lstrojny
 Block user comment: N
 Private report:     N

 New Comment:

Lars; You may want to fix the "view documentation" link on pecl.php.net/amqp.

The docs have been disabled now


Previous Comments:
------------------------------------------------------------------------
[2014-02-09 02:18:39] bjori@php.net

Automatic comment from SVN on behalf of bjori
Revision: http://svn.php.net/viewvc/?view=revision&revision=332808
Log: Disable AMQP docs.. probably remove completely later. See bug#66661

------------------------------------------------------------------------
[2014-02-09 01:44:31] lstrojny@php.net

@bjori: yes, please.

------------------------------------------------------------------------
[2014-02-08 22:45:04] phpbugs at rfnj dot org

FWIW I'm good with them being removed.  No docs is better than incorrect docs.

------------------------------------------------------------------------
[2014-02-08 18:32:28] bjori@php.net

It seems to me the best course of action is to remove the docs from php.net to avoid confusion.

The authors of pecl/AMQP have some sort of docs in the github repo and have no wishes to have the
extension documented on php.net or use any php.net infrastructure.

The only reason the ext is on pecl is so it can be "pecl install amqp" it seems,
everything else is outside of php.net, including docs.

Lars: Are you OK with removing the docs from php.net?

------------------------------------------------------------------------
[2014-02-08 17:40:02] phpbugs at rfnj dot org

Salathe, thanks for the link.  The work done there is over a year old, but they say svn.php.net was
updated with new documentation.  I can't find any official documentation over on that side that
could be used to update the php.net docs.

However there are code comment signatures for each function stub that are in *some* kind of auto
documenting format.  They are simply signatures though, with no explanation of the params.

Does the official project have documentation anywhere that could be used to update the php.net docs?

------------------------------------------------------------------------


The remainder of the comments for this report are too long. To view
the rest of the comments, please view the bug report online at

    https://bugs.php.net/bug.php?id=66661


-- 
Edit this bug report at https://bugs.php.net/bug.php?id=66661&edit=1


Thread (8 messages)

« previous php.doc.bugs (#10967) next »