Re: [PHP-DOC] Function References not showing up in docs for mixed case function names From: Lars Torben Wilson (torben <email protected>)
Date: 05/20/01

Daniel Beckham writes:
> As far as English grammar goes, they should be capitalized if they are the
> first word in a sentence. If you are using the function name as the first
> word though, you probably could come up with a better way to write it.
>
> bad: Foo() does bar;
> good: The function foo() does bar.
>
> Daniel

I agree with your second assertion. I could see a lot of users getting
confused if the first were followed blindly, though (say, if one was
documenting C). Which is one reason (besides style) why I agree with
the second assertion...:)

> ----- Original Message -----
> From: "Lars Torben Wilson" <torben <email protected>>
> Newsgroups: php.doc
> To: <jeroen <email protected>>
> Cc: <phpdoc <email protected>>
> Sent: Sunday, May 20, 2001 7:09 AM
> Subject: Re: [PHP-DOC] Function References not showing up in docs for mixed
> case function names
>
> > > And that even at the start of a sentence. You also don't write numbers
> in
> > > uppercase just because they happen to be the first 'word' of a sentence.
> >
> > Bad example: sentences shouldn't start with digits anyway. Spell the
> > word out at the start of a sentence. It remains largely undecided as
> > to whether function names should be capitalized when starting a
> > sentence--I personally believe they should not be, but not everybody
> > thinks that way. :)
>
> 

-- 
 Torben Wilson <torben <email protected>>
 http://www.thebuttlesschaps.com
 +1.604.709.0506