Improve programmer docs for simplehash and dynahash.
authorThomas Munro <tmunro@postgresql.org>
Sat, 1 Aug 2020 00:16:15 +0000 (12:16 +1200)
committerThomas Munro <tmunro@postgresql.org>
Sat, 1 Aug 2020 00:16:15 +0000 (12:16 +1200)
commit84c0e4b9bce794da914fe9c062753bf21369745f
tree67e2fa3533e5d38527ae5346638e7c910943a379
parentc79aed4f793086300abfc188def94b5c0bd0b45d
Improve programmer docs for simplehash and dynahash.

When reading the code it's not obvious when one should prefer dynahash
over simplehash and vice-versa, so, for programmer-friendliness, add
comments to inform that decision.

Show sample simplehash method signatures.

Author: James Coleman <jtc331@gmail.com>
Discussion: https://postgr.es/m/CAAaqYe_dOF39gAJ8rL-a3YO3Qo96MHMRQ2whFjK5ZcU6YvMQSA%40mail.gmail.com
src/backend/utils/hash/dynahash.c
src/include/lib/simplehash.h