Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: Uli Kusterer <email@hidden>
- Date: Sun, 10 Jul 2005 23:57:58 +0200
On Jul 10, 2005, at 19:48 , Raffael Cavallaro wrote:
Second, I suggested a single link labeled "sample code" for each
method in the API docs. That link, when clicked on, would go to a
page with a list of every occurrence of that method and class in
a .m file in the existing sample code. That would be, I assert:
"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.
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.
Cheers,
-- M. Uli Kusterer
http://www.zathras.de
_______________________________________________
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