Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Harpoon 2: unclear documentation for the list API #450

Open
GaetanLepage opened this issue Dec 27, 2023 · 3 comments
Open

Harpoon 2: unclear documentation for the list API #450

GaetanLepage opened this issue Dec 27, 2023 · 3 comments

Comments

@GaetanLepage
Copy link

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
Copy link

wojciech-kulik commented Jan 1, 2024

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.

@GaetanLepage
Copy link
Author

Thank you for the fix :)

@fira42073
Copy link

omg, thanks so much for this issue! I couldn't figure out why add wasn't being called.

Probably a good idea to fix it in the readme too

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants