FAQ
Edit report at https://pear.php.net/bugs/bug.php?id=19268&edit=1

ID: 19268
Updated by: hm2k@php.net
Reported By: cweiske at php dot net
Summary: Better documentation of parameters and return values
Status: Open
Type: Bug
Package: Services_Mailman
Package Version: SVN
PHP Version: Irrelevant
Roadmap Versions:
New Comment:

I have improved this, however my intention was to make it show this
through the end
user documentation, examples and tests.


Previous Comments:
------------------------------------------------------------------------

[2012-02-01 08:10:28] cweiske

Description:
------------
Some methods have parameters or return values I cease to understand
without looking at the source code. Those should be documented in a
better way.

Examples:

setOption(): @param string $option A valid option
Where am I supposed to get a list of valid options from? Do you have a
list? Please document that.

members(): @return array Returns a lits of members names and email
addresses
Is that an associative array? member name key, email value? The other
way round? Totally different? Give an example or describe that

fetch(): Isn't it possible that the request object throws an exception?
If yes, please either document it or catch and wrap the exception in
your own exception.

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

Search Discussions

  • Hm2k at Feb 1, 2012 at 10:25 am
    Edit report at https://pear.php.net/bugs/bug.php?id=19268&edit=1

    ID: 19268
    Updated by: hm2k@php.net
    Reported By: cweiske at php dot net
    Summary: Better documentation of parameters and return values
    -Status: Open
    +Status: Closed
    Type: Bug
    Package: Services_Mailman
    Package Version: SVN
    PHP Version: Irrelevant
    -Assigned To:
    +Assigned To: hm2k
    Roadmap Versions:
    New Comment:

    -Status: Open
    +Status: Closed
    -Assigned To:
    +Assigned To: hm2k



    Previous Comments:
    ------------------------------------------------------------------------

    [2012-02-01 11:26:49] hm2k

    I have improved this, however my intention was to make it show this
    through the end
    user documentation, examples and tests.

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

    [2012-02-01 08:10:28] cweiske

    Description:
    ------------
    Some methods have parameters or return values I cease to understand
    without looking at the source code. Those should be documented in a
    better way.

    Examples:

    setOption(): @param string $option A valid option
    Where am I supposed to get a list of valid options from? Do you have a
    list? Please document that.

    members(): @return array Returns a lits of members names and email
    addresses
    Is that an associative array? member name key, email value? The other
    way round? Totally different? Give an example or describe that

    fetch(): Isn't it possible that the request object throws an exception?
    If yes, please either document it or catch and wrap the exception in
    your own exception.

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

Related Discussions

Discussion Navigation
viewthread | post
Discussion Overview
grouppear-bugs @
categoriesphp
postedFeb 1, '12 at 10:25a
activeFeb 1, '12 at 10:25a
posts2
users1
websitepear.php.net

1 user in discussion

Hm2k: 2 posts

People

Translate

site design / logo © 2022 Grokbase