search

aisk / pick

create curses based interactive selection list in the terminal
MIT License
729 stars 63 forks source link

RFE: Document Pick methods #81

Closed volklord closed 2 years ago

volklord commented 2 years ago

Would you please document the methods in Pick?

As it is currently, it is a guess game what the various methods actually do. Well, move_up() and move_down() can be guessed correctly, but register_custom_handler(), get_option_lines(), get_lines() etc. might not be guessed easily. I would to suggest to mark those methods as private if you don't want them to be used from outside.

Thanks by the way for writing the library.

wong2 commented 2 years ago

Hi, register_custom_handler have been removed recently. Other methods you mentioned are not intended to be used outside.