commit: 6089a42b8903932a06cb3150eaaad7cae59b4a73
Author: Maciej Barć <xgqt <AT> gentoo <DOT> org>
AuthorDate: Tue Aug 16 20:31:32 2022 +0000
Commit: Maciej Barć <xgqt <AT> gentoo <DOT> org>
CommitDate: Tue Aug 16 20:31:32 2022 +0000
URL:
https://gitweb.gentoo.org/proj/company-ebuild.git/commit/?id=6089a42b
company-ebuild.el: extend company-ebuild-setup commentary
Signed-off-by: Maciej Barć <xgqt <AT> gentoo.org>
company-ebuild.el | 8 +++++++-
1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/company-ebuild.el b/company-ebuild.el
index 022a058..3f4cceb 100644
--- a/company-ebuild.el
+++ b/company-ebuild.el
@@ -245,7 +245,13 @@ ARG is the completion argument for annotation and
candidates."
;;;###autoload
(defun company-ebuild-setup ()
- "Setup for Company-Ebuild."
+ "Setup for Company-Ebuild.
+
+To setup the integration correctly, add this function to ‘ebuild-mode-hook’
+in your config:
+\(add-hook 'ebuild-mode-hook 'company-ebuild-setup)
+or `require' Company-Ebuild:
+\(require 'company-ebuild)"
;; Force-enable `company-mode'.
(when (null company-mode)
(company-mode +1))
