ThePrimeagen/harpoon

Harpoon 2: unclear documentation for the list API

Opened this issue · 2 comments

GaetanLepage commented

Hello,

It is unclear what are the functions in HarpoonPartialConfigItem (i.e. the configuration for a custom list).
The README mentions an add function whereas in this code comment, there is no add function but there is an extra create_list_item.

Which source of information is correct ?

Thanks !

wojciech-kulik commented

I confirm, the example from readme is incorrect. You need to use create_list_item instead of add. Took some time to figure out what's wrong.

It would be also nice to have an example in the readme of how to use named lists. Otherwise, everyone will have to browse the code to figure it out.

  • 👍1
GaetanLepage commented

Thank you for the fix :)

  • ❤️1