[PEPr] Comment on Web Services::WindowsLive_Contacts
| From: | Michael Gauthier | Date: | Tue, 23 Dec 2008 17:08:36 +0000 |
| Subject: | [PEPr] Comment on Web Services::WindowsLive_Contacts | ||
| References: | 1 | Groups: | php.pear.dev |
| Request: | Send a blank email to pear-dev+get-51346@lists.php.net to get a copy of this message | ||
Michael Gauthier (http://pear.php.net/user/gauthierm) has commented on the proposal for Web
Services::WindowsLive_Contacts.
Comment:
Nice use of HTTP_Request2. I have a few of suggestions.
1.) First, it would probably be better to use the HTTP object like a
template. See http://pear.php.net/bugs/bug.php?id=15072. The
way you
currently have it implemented, for example, will cause the body of the
previous request to be sent for subsequent requests that do not specify a
body (Lines 312-314).
2.) Second, I suggest renaming the protected property HttpObject to start
with a lower-case 'h' like your other properties.
3.) For your method documentation, you are simple restating the method
name as the documentation summary. "Summaries for methods should use 3rd
person declarative rather than 2nd person imperative, beginning with a verb
phrase." For example: "Generates the URI to use when contacting the Web
service"
4.) Adding unit tests would be nice.
In all, great work so far. I think this package will be popular in PEAR.
Proposal information:
http://pear.php.net/pepr/pepr-proposal-show.php?id=564
--
Sent by PEPr, the automatic proposal system at http://pear.php.net