Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Raffael Cavallaro <email@hidden>
- Date: Sun, 10 Jul 2005 18:40:39 -0400
On Jul 10, 2005, at Sun, Jul 10, 5:57 58 PM, Uli Kusterer wrote:
"Sample code" isn't a good name for autogenerated lists. Maybe an
Amazon-like link "Search for sample code containing 'drawRect:'"
would help, though. There are often cases where I wish I just had
any piece of code that demonstrates an actual use of a method.
However, a "sample code" link I would reserve for hand-selected
example code.
Works for me. I don't really care what the link would be called - it
could even be a simple icon - just as long as it goes to idiomatic
code.
1. minimally intrusive - it would consist of a single link "sample
code" for each method in the existing API reference docs. If
people don't want to see that auto-generated page, they just don't
click on the link. That's all. The additional two words "sample
code" for each method in the API reference are easily ignored by
those who don't want to see the auto-generated sample code list.
But please no such link if there are no hits, and no "sample code"
link if there is no sample code for this section. There's nothing
more annoying and confidence-destroying than finding a link to
nowhere.
Agreed - I took for granted that there wouldn't be a link if there
were no code using that method.
regards,
Ralph
Raffael Cavallaro, Ph.D.
email@hidden
_______________________________________________
Do not post admin requests to the list. They will be ignored.
Cocoa-dev mailing list (email@hidden)
Help/Unsubscribe/Update your Subscription:
This email sent to email@hidden