galeo / corfu-doc

Documentation popup for Corfu
GNU General Public License v3.0
64 stars 4 forks source link

Please provide clearer information on migration in README #25

Closed ksqsf closed 1 year ago

ksqsf commented 1 year ago

Important: this package has been merged into Corfu as one of its extensions. And this repository is deprecated now.

"one of its extensions" is unnecessarily vague. Please at least say which extension.

galeo commented 1 year ago

Currently It's corfu-popupinfo.

;; NOTE: This extension has been added recently to Corfu. It is still ;; experimental. The extension may get renamed and the public interface ;; may change any time.

I didn't give a specific name because of the caveat above. I see this warning was just removed, but not sure if it will change in the future. Therefore, the current statement I think is reasonable.