[asterisk-dev] Documenting Function Examples

[BJ Weschke]

On 5/2/06, Peter Beckman <beckman at purplecow.com> wrote:
> Hey guys --
>
> I'm trying to standardize how we're going to document function examples.
> Can I get an opinion on what format is more correct, now and in the future?
>
>     1. exten => s,1,Authenticate(${PASSWORD} | a)
>
>     2. exten => s,1,Authenticate(${PASSWORD}| a)
>
>     3. exten => s,1,Authenticate(${PASSWORD}|a)
>
>     4. exten => s,1,Authenticate(${PASSWORD}, a)
>
>     5. exten => s,1,Authenticate(${PASSWORD},a)
>

 I'd probably say option 3 although I'd imagine 1 and 2 will work in
most cases as well. We've tried to start standardizing on the | as our
argument separator when possible.

--
Bird's The Word Technologies, Inc.
http://www.btwtech.com/