GNU bug report logs - #6851
Documentation: `make-hash-table' "add that many space"

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 6851 in the body.
You can then email your comments to 6851 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: MON KEY <monkey <at> sandpframing.com>
To: bug-gnu-emacs <at> gnu.org
Subject: Documentation: `make-hash-table' "add that many space"
Date: Fri, 13 Aug 2010 14:19:29 -0400

Documentation: `make-hash-table' "add that many space"

,---- (documentation 'make-hash-table)
|
|  { ... }
|
| :rehash-size REHASH-SIZE - Indicates how to expand the table when it
| fills up.  If REHASH-SIZE is an integer, add that many space.  If it
| is a float, it must be > 1.0, and the new size is computed by
| multiplying the old size with that factor.  Default is 1.5.
|
|  { ... }
|
`----


Following sentence doesn't parse:

 "If REHASH-SIZE is an integer, add that many space."
                                         ^^^^ ^^^^^
Even if what the author meant was:

 "If REHASH-SIZE is an integer, add that much space."

it still won't yield a satisfactory parse b/c space isn't a term
specified elsewhere in the doc so it isn't clear which space is being
added to.


Problem current through Bzr-101071

--
/s_P\

Message #8 received at 6851 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: MON KEY <monkey <at> sandpframing.com>
Cc: 6851 <at> debbugs.gnu.org
Subject: Re: bug#6851: Documentation: `make-hash-table' "add that many space"
Date: Fri, 13 Aug 2010 20:39:58 -0400

MON KEY <monkey <at> sandpframing.com> writes:

> | :rehash-size REHASH-SIZE - Indicates how to expand the table when it
> | fills up.  If REHASH-SIZE is an integer, add that many space.  If it
> | is a float, it must be > 1.0, and the new size is computed by
> | multiplying the old size with that factor.  Default is 1.5.

> Following sentence doesn't parse:
>
>  "If REHASH-SIZE is an integer, add that many space."
>                                          ^^^^ ^^^^^
> Even if what the author meant was:
>
>  "If REHASH-SIZE is an integer, add that much space."
>
> it still won't yield a satisfactory parse b/c space isn't a term
> specified elsewhere in the doc so it isn't clear which space is being
> added to.

Thanks.  I checked in a fix.  The "number of spaces" is the nominal size
of the hash table, defined in the preceding part of the docstring.

Message #13 received at 6851 <at> debbugs.gnu.org (full text, mbox):

From: MON KEY <monkey <at> sandpframing.com>
To: Chong Yidong <cyd <at> stupidchicken.com>
Cc: 6851 <at> debbugs.gnu.org
Subject: Re: bug#6851: Documentation: `make-hash-table' "add that many space"
Date: Sat, 14 Aug 2010 00:52:02 -0400

On Fri, Aug 13, 2010 at 8:39 PM, Chong Yidong <cyd <at> stupidchicken.com> wrote:
> Thanks.  I checked in a fix.  The "number of spaces" is the nominal size
> of the hash table, defined in the preceding part of the docstring.
>

Yes. My point is was that "space" is a loaded term, esp. w/re hashes.

Also, I noticed this:

,----
|
| {...}
|
| :rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0.
| Resize the hash table when the ratio (number of entries / table size)
| is greater or equal than THRESHOLD.  Default is 0.8.
|
| {...}
|
`----

"is greater or equal than THRESHOLD.  Default is 0.8."
    ^^^^^^^^^^^^^^^^^^^^^

Maybe better as:

"is greater than or equal to THRESHOLD. Default is 0.8."


Appears through Bzr-101073

--
/s_P\

Message #16 received at 6851 <at> debbugs.gnu.org (full text, mbox):

From: Chong Yidong <cyd <at> stupidchicken.com>
To: MON KEY <monkey <at> sandpframing.com>
Cc: 6851 <at> debbugs.gnu.org
Subject: Re: bug#6851: Documentation: `make-hash-table' "add that many space"
Date: Sat, 14 Aug 2010 17:14:12 -0400

MON KEY <monkey <at> sandpframing.com> writes:

> | :rehash-threshold THRESHOLD -- THRESHOLD must a float > 0, and <= 1.0.
> | Resize the hash table when the ratio (number of entries / table size)
> | is greater or equal than THRESHOLD.  Default is 0.8.

> Maybe better as:
>
> "is greater than or equal to THRESHOLD. Default is 0.8."

Thanks, fixed.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.