Re[2]: [PEAR-QA] Documentation..
| From: | anatoly techtonik | Date: | Thu, 16 Dec 2004 13:24:06 +0000 |
| Subject: | Re[2]: [PEAR-QA] Documentation.. | ||
| References: | 1 2 3 4 5 6 7 8 9 10 11 12 13 | Groups: | php.pear.qa |
| Request: | Send a blank email to pear-qa+get-2208@lists.php.net to get a copy of this message | ||
Hello bertrand,
bG> Are you still so kind to help again?
bG> As you know, I'm not so that good in english, what's all that mean?
Not a problem. But I have troubles with english too. =)
>>Well, where did you read about quick access? I'm speaking about documentation
>>quality. I disagreed with Greg, that documentation should lack
>>tutorials candy.
bG> "lack tutorials candy" ?
Tutorials is a kind of documentation what is pleasant to read. Good
book is readed from start to the end with only one feeling - pleasure.
So it is like candy - it is a pleasure to consume one from start till
the end. =)
API docs with only method descriptions are deprived of such reading
pleasure, becuase they don't follow logical chain to form a complete
vision of the package structure and idea.
>> For me it is essential part to get a clear understanding
>>of what package does and how can I use what is does for me.
bG> "how can I use what is does for me" ?
1. I need to understand what this package does.
2. I need to understand how to use this package.
3. I need to understand what this package does for me.
4. I need to understand how can I use this package to solve my
problems.
5. Or I need to understand how can I use this package to make it do what
it does for me.
So there is actually an error in my post and it can be rephrased as :
"how can I use what does it do for me?" or
"how can I use what it does for me?"
Well, I don't know which one from these two is correct. =(
Can anybody correct me?
>> For example it can be clear that types for $me->type can be
>> "string", "integer" and "array", but what this is the type of
>> the whole XML_RPC_Value - this info can be left unnoticed.
>>
bG> ???
Well, it is my infatuation for XML-RPC. =)
There is an object, called XML_RPC_Value. In description for an
object there can be string "Object contains XML_RPC value". That
object manual can contain variable descriptions like
$me->value
value content
$me->type
value type
But it is not clear that XML_RPC_Value is a real-world object, which
is identified by it's type and value and the main purpose of this
object is to present this value in common format to be understood by
Client and Server without regards Server and Client being written in
the same language or not. What XML_RPC_Value is an object, which is
wrapped by XML_RPC_Response and XML_RPC_Message while
receiving/sending these from/to server. You can include that
information in XML_RPC_Value object description, but you also need to
include this information to XML_RPC_Response and XML_RPC_Message
descriptions. That way you will probably notice that you've already
read that part and skip it. There can be an endless loop between pages
until you finally realize, that there is no answer to your question
in the package manual. Welcome to the end-user API docs. =)
Tutorials are candy - because after reading them once you can clearly
say how this tutorial can be enhanced and which questions are left
unanswered.
t
--