Re: running an external app
Re: running an external app
- Subject: Re: running an external app
- From: Greg Titus <email@hidden>
- Date: Tue, 27 May 2008 08:05:27 -0700
On May 27, 2008, at 12:18 AM, Peter Duniho wrote:
Now, as it happens, NSWorkspace has a perfectly useful example, in
the "Overview" section of the documentation. Frankly, while I'd
prefer "one method per doc page" documentation, with more detailed
descriptions and more code samples, in the context of the docs as
they are today, there's a readily accessible example of how to get
an instance of NSWorkspace in the very part of the docs anyone ought
to be reading before they try to use the class.
But if the docs were fixed (admittedly, that's "fixed" in my own
sense of the word :) ) so that each method had a dedicated page,
even though the "Overview" page would still have the same example
the section has now, it wouldn't be all that unreasonable to expect
a code sample for all but the most trivial methods that includes
typical usage (and in this case, that would include demonstrating
where you'd get the instance). And frankly, I don't see what would
be so bad about including such examples on all but the most trivial
examples even as the docs are now.
I think that's reasonable. If the docs were reorganized so that every
method had its own page, then it would be perfectly reasonable to have
each of those pages contain a little bit of context about the class -
the kind of thing that is currently in the Overview section. But in my
view, that would be a drawback of one-method-per-page organization:
that you wouldn't have as much meta-information about where and which
document you are in and the breadth of methods available, so each
individual page would need to repeat more.
- Greg
_______________________________________________
Cocoa-dev mailing list (email@hidden)
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:
This email sent to email@hidden