API presentation vs API atoms description. Was: [PEAR-QA] Documentation..
| From: | anatoly techtonik | Date: | Thu, 16 Dec 2004 12:30:44 +0000 |
| Subject: | API presentation vs API atoms description. Was: [PEAR-QA] Documentation.. | ||
| References: | 1 2 3 4 5 6 7 8 9 10 11 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-2207@lists.php.net to get a copy of this message | ||
Hello Greg,
>> symbols. I need more time to get correct information, because I've got
>> a lot of superfluous data and that is inconvenient. Like spam. =)
GB> This is the first and last time I will hear years of work referred to as
GB> "spam"
GB> Right?
Nope. You've taken that too personal. I said that I said. Nothing more. And I
haven't said about your years of work being spam. I've only mentioned, that there
are other ways to present package API information, which are more convenient
for ME. As a reason for such sympathy in comparison with your presentation
format I brought this simple methaphor that XML-RPC tutorial-style documentation
is organized better by leaving only one learning line to complete package
picture and thus leaving all confusing stuff out of readers attention. "spam"
is "confusing stuff" in this context.
You have one line - you follow it until the end - you've got whole
package idea and a bunch of ways how to move on with this package.
You have multiple lines - you follow constructor description, then
some methods description until you find one way to solve your problem.
You can read all methods descriptions and don't get a picture.
If you can place a voting somewhere - you will get a real statistics about
originality of my POV.
GB> Greg
GB> P.S. this is the first and last time I will respond to this thread.
That was hastily. =/ Though the thread was changed you still can answer me
personally. Your comments are always welcome.
t
--