Re: Incomplete documentation on 'need'

[Alexander Burger]

Hi all,

On Sat, Dec 03, 2016 at 07:12:59PM -0500, Joe Bogner wrote:
> Perhaps an additional example would be useful in the docs, but it's
> easy enough to try in the repl

Thanks Joe! I added one more example.

♪♫ Alex
-- 
UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe

Re: Incomplete documentation on 'need'

[Bruno Franco]

I got it! Yes! Thank you Joh. You too Joe, your example helped me a lot!
It really was in the documentation, I just missed it because the opening
paragraph didn't say it explicitly. I guess this is the kind of mistakes
that come from lack of experience.

So, as recap: the 'any argument is the extensor, and it sets what 'lst will
be extended with. And if its not given, it defaults to NIL.

On Sat, Dec 3, 2016 at 7:12 PM, Joe Bogner  wrote:

> Hi Bruno, welcome!
>
> I agree the documentation is terse, but I think it's clear.
>
> "When lst is given, it is extended to the left (if cnt is positive) or
> (destructively) to the right (if cnt is negative) with any elements"
>
> Here's an example
>
> Perhaps an additional example would be useful in the docs, but it's
> easy enough to try in the repl
>
> # extend with NIL, same as (need 5)
> : (need 5 '(1 2))
> -> (NIL NIL NIL 1 2)
>
> # extend with a (1 2) with 3 1s
> : (need 5 '(1 2) 1)
> -> (1 1 1 1 2)
>
>
> On Sat, Dec 3, 2016 at 5:59 PM, Joh-Tob Schäg  wrote:
> > You are welcome. But from my personal experience the documentation is
> rather
> > terse and changes happen not that often.
> >
> > Also (doc 'need) does state what it does do. Read the last two lines
> `second
> > form`. It is very unclear and i hope Regenaxer takes a look and clarifies
> > it.
> >
> > 2016-12-03 23:41 GMT+01:00 Bruno Franco :
> >>
> >> Thanks Chri! I'm relieved to hear you say that. I'll make sure to send
> any
> >> question I have.
> >>
> >> On Sat, Dec 3, 2016 at 5:12 PM, Christophe Gragnic
> >>  wrote:
> >>>
> >>> On Sat, Dec 3, 2016 at 10:54 PM, Bruno Franco
> >>>  wrote:
> >>> > I just wanted to point out that (doc 'need) for version 15.11.0 seems
> >>> > to
> >>> > miss something.
> >>> > […]
> >>> > I also wanted to ask if this kind of topic was appropriate for the
> >>> > mailing
> >>> > list. It seems so small that I wouldn't want to bother everyone just
> to
> >>> > point it out.
> >>>
> >>> I can't say anything about 'need, but I can answer the last question.
> >>> This list is very friendly, especially with newbies.
> >>> You can ask any question or point us to anything.
> >>>
> >>>
> >>> chri
> >>> --
> >>> UNSUBSCRIBE: mailto:picolisp@software-lab.de?subjectUnsubscribe
> >>
> >>
> >
> --
> UNSUBSCRIBE: mailto:picolisp@software-lab.de?subjectUnsubscribe
>

Re: Incomplete documentation on 'need'

[Joe Bogner]

Hi Bruno, welcome!

I agree the documentation is terse, but I think it's clear.

"When lst is given, it is extended to the left (if cnt is positive) or
(destructively) to the right (if cnt is negative) with any elements"

Here's an example

Perhaps an additional example would be useful in the docs, but it's
easy enough to try in the repl

# extend with NIL, same as (need 5)
: (need 5 '(1 2))
-> (NIL NIL NIL 1 2)

# extend with a (1 2) with 3 1s
: (need 5 '(1 2) 1)
-> (1 1 1 1 2)


On Sat, Dec 3, 2016 at 5:59 PM, Joh-Tob Schäg  wrote:
> You are welcome. But from my personal experience the documentation is rather
> terse and changes happen not that often.
>
> Also (doc 'need) does state what it does do. Read the last two lines `second
> form`. It is very unclear and i hope Regenaxer takes a look and clarifies
> it.
>
> 2016-12-03 23:41 GMT+01:00 Bruno Franco :
>>
>> Thanks Chri! I'm relieved to hear you say that. I'll make sure to send any
>> question I have.
>>
>> On Sat, Dec 3, 2016 at 5:12 PM, Christophe Gragnic
>>  wrote:
>>>
>>> On Sat, Dec 3, 2016 at 10:54 PM, Bruno Franco
>>>  wrote:
>>> > I just wanted to point out that (doc 'need) for version 15.11.0 seems
>>> > to
>>> > miss something.
>>> > […]
>>> > I also wanted to ask if this kind of topic was appropriate for the
>>> > mailing
>>> > list. It seems so small that I wouldn't want to bother everyone just to
>>> > point it out.
>>>
>>> I can't say anything about 'need, but I can answer the last question.
>>> This list is very friendly, especially with newbies.
>>> You can ask any question or point us to anything.
>>>
>>>
>>> chri
>>> --
>>> UNSUBSCRIBE: mailto:picolisp@software-lab.de?subjectUnsubscribe
>>
>>
>
--
UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe

Re: Incomplete documentation on 'need'

[Joh-Tob Schäg]

You are welcome. But from my personal experience the documentation is
rather terse and changes happen not that often.

Also (doc 'need) does state what it does do. Read the last two lines
`second form`. It is very unclear and i hope Regenaxer takes a look and
clarifies it.

2016-12-03 23:41 GMT+01:00 Bruno Franco :

> Thanks Chri! I'm relieved to hear you say that. I'll make sure to send any
> question I have.
>
> On Sat, Dec 3, 2016 at 5:12 PM, Christophe Gragnic <
> christophegrag...@gmail.com> wrote:
>
>> On Sat, Dec 3, 2016 at 10:54 PM, Bruno Franco
>>  wrote:
>> > I just wanted to point out that (doc 'need) for version 15.11.0 seems to
>> > miss something.
>> > […]
>> > I also wanted to ask if this kind of topic was appropriate for the
>> mailing
>> > list. It seems so small that I wouldn't want to bother everyone just to
>> > point it out.
>>
>> I can't say anything about 'need, but I can answer the last question.
>> This list is very friendly, especially with newbies.
>> You can ask any question or point us to anything.
>>
>>
>> chri
>> --
>> UNSUBSCRIBE: mailto:picolisp@software-lab.de?subjectUnsubscribe
>>
>
>

Re: Incomplete documentation on 'need'

[Christophe Gragnic]

On Sat, Dec 3, 2016 at 10:54 PM, Bruno Franco
 wrote:
> I just wanted to point out that (doc 'need) for version 15.11.0 seems to
> miss something.
> […]
> I also wanted to ask if this kind of topic was appropriate for the mailing
> list. It seems so small that I wouldn't want to bother everyone just to
> point it out.

I can't say anything about 'need, but I can answer the last question.
This list is very friendly, especially with newbies.
You can ask any question or point us to anything.


chri
--
UNSUBSCRIBE: mailto:picolisp@software-lab.de?subject=Unsubscribe

Incomplete documentation on 'need'

[Bruno Franco]

I just wanted to point out that (doc 'need) for version 15.11.0 seems to
miss something.
It defines the possible arguments of need as:

(need 'cnt ['lst ['any]])

But it doesn't say what the function does with 'any, or how it affects the
result.

I also wanted to ask if this kind of topic was appropriate for the mailing
list. It seems so small that I wouldn't want to bother everyone just to
point it out.