On May 27, 2008, at 1:35 PM, Peter Duniho wrote:
We can agree to disagree.
Sure thing, no problem.
IMHO, a code sample, providing some real context on the use of the
method, is very beneficial.
For some methods of some classes, I'd be first to agree an example in
context is very useful -- or, to put it more strongly, the omission of
such an example would be a glaring error. But to me the vast majority
of methods, including -launchApplication:, are "trivial" in the sense
you gave. I'm perfectly capable of converting the method declaration
to a method call -- assuming, as I said, that the arguments and return
value have been explained.
Yes, I know the standard counter-argument: "it's a reference, not a
guide". I simply disagree. Yes, it's a reference. But that
shouldn't preclude the inclusion of code snippets that illustrate
the use of the class member in context.
Nobody is saying that AFAIK. There are plenty of methods that have
code snippets, as well as a mechanism for submitting feedback when you
think an example should be added in a particular case.
Even though the method being documented is launchApplication, that
doesn't mean there's no benefit in also documenting in the same
place how you'd use it along with other Cocoa features (such as
LaunchServices, as you point out).
No.
I was pointing out that the docs don't explain how -launchApplication:
locates the .app to execute, or how it decides between two .apps with
the same name. I would fully expect and prefer this explanation to be
in text, not code.
But I'm fine with simply disagreeing and leaving it at that.
--Andy
_______________________________________________
Cocoa-dev mailing list (Cocoa-dev@lists.apple.com)
Please do not post admin requests or moderator comments to the list.
Contact the moderators at cocoa-dev-admins(at)lists.apple.com
Help/Unsubscribe/Update your Subscription:
http://lists.apple.com/mailman/options/cocoa-dev/archive%40mail-archive.com
This email sent to [EMAIL PROTECTED]
