clisp-devel

AW: hashtable documentation

[Hoehle, Joerg-C. <Joe...@t-...>]

Bruno wrote:
>>  - :value-type and:key-type are not documented
>:value and :key are documented in impext.xml.
I had seen that.

> We have split the description
>of MAKE-HASH-TABLE into a more general part in impbody.xml and a
>weak hash table description in impext.xml.

Yes, yet :value-type :key-type are still not documented.

And I found documentation very misleading that start like
"the options are :this, :that"
and several paragraphs later
"allowed options are also :foo and :bar".
I expect a complete summary at the start, or none at all (or some =
verbiage to tell that this is part of the picture).

I've submited bugreports for mnpages written that way (e.g. dpkg on =
Debian), make-hash-table is described similarly in impnotes and I =
forgot another similar description I encountered.

Regards,
	J=C3=B6rg H=C3=B6hle.

Re: AW: hashtable documentation

[Bruno H. <br...@cl...>]

J=C3=B6rg wrote:
> > We have split the description
> > of MAKE-HASH-TABLE into a more general part in impbody.xml and a
> > weak hash table description in impext.xml.
>
> Yes, yet :value-type :key-type are still not documented.

I'm confused now. - Sam, can you please regenerate impnotes.html? (I don't
easily understand doc bug reports if all I can look at is the xml source.)
Thanks in advance.

Bruno

Re: AW: hashtable documentation

[Sam S. <sd...@gn...>]

> * Bruno Haible <oe...@py...> [2005-06-15 19:15:00 +0200]:
>
> - Sam, can you please regenerate impnotes.html? (I don't easily
> understand doc bug reports if all I can look at is the xml source.)

<http://www.podval.org/~sds/clisp/impnotes/> is regenerated nightly.

-- 
Sam Steingold (http://www.podval.org/~sds) running w2k
<http://www.memri.org/> <http://www.openvotingconsortium.org/>
<http://www.camera.org> <http://ffii.org/> <http://www.palestinefacts.org/>
"A pint of sweat will save a gallon of blood."          -- George S. Patton

Re: AW: hashtable documentation

[Bruno H. <br...@cl...>]

Sam,
> <http://www.podval.org/~sds/clisp/impnotes/> is regenerated nightly.

Thank you! I bookmarked it now finally :-)

Bruno

Re: AW: hashtable documentation

[Bruno H. <br...@cl...>]

J=C3=B6rg wrote:
> Yes, yet :value-type :key-type are still not documented.

Ah, you mean the keyword arguments :KEY-TYPE and :VALUE-TYPE ? Yes,
they are not documented, because currently they act only as comments:
  - there's no accessor for it,
  - there's no type check at runtime,
  - the compiler doesn't make use of this information.

I use these keyword arguments heavily inside clisp; but it doesn't mean it's
ready for the average user.

Bruno