summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMaciej Barć <xgqt@gentoo.org>2022-08-16 22:31:32 +0200
committerMaciej Barć <xgqt@gentoo.org>2022-08-16 22:31:32 +0200
commit6089a42b8903932a06cb3150eaaad7cae59b4a73 (patch)
tree63ceba2f637ed3f27355c9c5e64c684626567d56
parentcompany-ebuild.el: company-ebuild--find-repo-root guards (diff)
downloadcompany-ebuild-6089a42b8903932a06cb3150eaaad7cae59b4a73.tar.gz
company-ebuild-6089a42b8903932a06cb3150eaaad7cae59b4a73.tar.bz2
company-ebuild-6089a42b8903932a06cb3150eaaad7cae59b4a73.zip
company-ebuild.el: extend company-ebuild-setup commentary
Signed-off-by: Maciej Barć <xgqt@gentoo.org>
-rw-r--r--company-ebuild.el8
1 files changed, 7 insertions, 1 deletions
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))