Re: Docs
Re: Docs
- Subject: Re: Docs
- From: Simon Stapleton <email@hidden>
- Date: Thu, 23 Aug 2001 09:47:11 +0100 (BST)
>
From: Angela Brett <email@hidden>
>
Subject: RE: Docs
>
>
At 4:19 PM -0700 22/8/01, Stuppel, Searle @ San Diego Central wrote:
>
>as i was saying in some other email to Ondra, "interpret"
and "scan"
>
>would be the last words i would think of searching for when i am
>
>looking for a function to remove URL's out of a NSString.
>
>
I completely agree that the docs could do with improvement - the
>
summaries as you suggested, examples of how to use each thing, and
of
>
course, the arrival of all these 'Forthcoming' parts.
I seem to recall that when I discovered 'NSScanner', it was through
the documentation. I _think_ it was from the TOC in the 'how to do
various things' section, and although the documentation _there_ was
incomplete it gave me enough of a taste and a pointer to get to the
real docs.
Personally speaking, I really don't have a problem with the docs.
There's a 'few' things missing, which could do with having some docs
added, but the layout and content isn't as bad as most folks keep
saying. Of course, I come from a commercial C++ background, and am
used to rubbish, impossible to read or search, documentation in
packages costing hundreds of thousands of pounds, so maybe it's just
that my expectations are lower. And, of course, I'm used to working
out how things work from the minimum of documentation.
And, on a related note, and again for me, if I was looking for
something to rip substrings out of strings, 'scan' and 'scanner'
would be the first things I tried.
>
As for NSScanner, I think it's perfectly normal, when learning a
new
>
development environment, to discover something halfway through
which
>
would have been a great help in the beginning. It's happened to me
>
long before Cocoa. No matter how good the documentation is, you
can't
>
know everything straight away unless you read all the documentation
>
before writing a line of code (which would be dead boring!) Some
>
things you won't even be searching for because you never even
>
considered that those capabilities might exist. It's just a part of
>
the learning process/adventure.
Hear hear!
Simon
--
If the answer isn't obvious, the question is a distraction. Go find
an
easier question.