Re: Documentation frustrations
Re: Documentation frustrations
- Subject: Re: Documentation frustrations
- From: mmalcolm crawford <email@hidden>
- Date: Sun, 10 Jul 2005 14:51:01 -0700
On Jul 10, 2005, at 2:26 PM, Andre wrote:
I'm in interface builder, and I am learning bindings, so I open the
inspector to inspect one of your Coredata/Bindings examples, so I
mouse over each binding such as contentValues and the tooltip says
"specifies the content values of the bound object" well, not to be
offensive, but, naw really?? Thats a totally useless tooltip.
[...]
Here is the ideal solution, I'm in the bindings inspector, I mouse
over each binding, a tool tip gives a real explanation, not just
the binding name plus spaces and verbs.
These are really tools issues rather than issues with the
documentation per se. Please file enhancement requests for Interface
Builder.
Another example, I want to find more info relating to @unionOfSets
that I found in one of the bindings, so I search in interface
builder help for @unionOfSets... nothing.
Interface Builder's help system gives help about use of the
application, it's not intended to serve as an API reference.
Ok, I search in XCode documentation, I get two results, with the
place not being highlighted (in the text it should also jump there)
where the text was found, so I do another search (cmd+F), and find
it... here is the explanation for the key @unionOfSets : "The
@unionOfSets array operator" ... gee thanks! That explains everything!
I'm not sure how you're searching for this?
An API search yields nothing, since it's not really API (although
this might be worth special-casing). If I do a full-text search for
@unionOfSets, I get 5 matches:
Two in the "Key-Value Coding Programming Guide" (one listed as being
to the Document Revision History, which I can exclude, the other is
"Set and Array Operators"), one to "Cocoa Bindings Programming
Topics" (Providing Controller Content); one to the NSKKeyValueCoding
protocol in the Foundation Reference; and one to the Foundation
Reference Update.
It's a moment's thought to decide that the best match is likely to be
"Set and Array Operators", and whilst clicking on the link doesn't
take me directly to the definition, it's a second or two's scrolling...
Are the people that write the docs also the same engineers that
work on the code??
No.
mmalc
_______________________________________________
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