From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: Heime via Users list for the GNU Emacs text editor Newsgroups: gmane.emacs.help Subject: User specified instructions for appending additional details to function documentation Date: Tue, 10 Dec 2024 19:07:05 +0000 Message-ID: <5OFa657U-oSOGqdhsDX-6xviE9mBoebeh7GTa-puCOXY8_3B88ft1DiFkjt3TDUnZMVNFZ6YFXdoH_u_n9rzk7pSpiCiZBfO0eu_FbCSTlU=@protonmail.com> Reply-To: Heime Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="867"; mail-complaints-to="usenet@ciao.gmane.io" To: Heime via Users list for the GNU Emacs text editor Original-X-From: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Tue Dec 10 20:08:00 2024 Return-path: Envelope-to: geh-help-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1tL5aR-00004s-HL for geh-help-gnu-emacs@m.gmane-mx.org; Tue, 10 Dec 2024 20:07:59 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tL5Zl-0002Lt-9y; Tue, 10 Dec 2024 14:07:17 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tL5Zj-0002LT-6M for help-gnu-emacs@gnu.org; Tue, 10 Dec 2024 14:07:15 -0500 Original-Received: from mail-10698.protonmail.ch ([79.135.106.98]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tL5Zh-0000NY-6h for help-gnu-emacs@gnu.org; Tue, 10 Dec 2024 14:07:14 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1733857629; x=1734116829; bh=W8wnQbkK1uCrbjWK2Ftb132JXn4pmDI3rAvVtY5gPLw=; h=Date:To:From:Subject:Message-ID:Feedback-ID:From:To:Cc:Date: Subject:Reply-To:Feedback-ID:Message-ID:BIMI-Selector: List-Unsubscribe:List-Unsubscribe-Post; b=fPm3laOvjlibtyohzf6eweyZPakT/IjQibf8BqwqIt5klez/6Xm1LSEIn3o8blyQb u5+CH6O/UQmguCIAaIDC19JRsKVPukxYgjT37uhuxZuMjuIYisBc9TCPhMm4GKJnUo Ft6xXwMntLMPKncL4A6pkdbaA3eirmi/ZHY3em1QK6zhsDm95oa27VWf8iI8k5n1h8 SbSEotYV6aXxbPdOJiHKvxV8Dcu3sesmFYfsuplXaoLh7cQieaq3JMgz88XRLVrIZ+ ysR142r9GzvssUb7yC7Nr6JYna3I1In20Ha/xw8FRqVE2M9wqjK99DqfC3PAXDGSIr HE/SKqHmF6g3A== Feedback-ID: 57735886:user:proton X-Pm-Message-ID: c8393bfb67a3aa03427977f9f0b3ee00f383e23c Received-SPF: pass client-ip=79.135.106.98; envelope-from=heimeborgia@protonmail.com; helo=mail-10698.protonmail.ch X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FREEMAIL_FROM=0.001, RCVD_IN_VALIDITY_RPBL_BLOCKED=0.001, RCVD_IN_VALIDITY_SAFE_BLOCKED=0.001, SPF_HELO_PASS=-0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: help-gnu-emacs@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: Users list for the GNU Emacs text editor List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: help-gnu-emacs-bounces+geh-help-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.help:148750 Archived-At: I have the function company-launch to which I add the documentation via keyword :documentation, appending the value of company-launch-qtr-doc. I want to have a user defined switch for the user to decide whether he want= s=20 the further details provided by company-launch-qtr-doc or not. What can be done about this? (defvar company-launch-qtr-doc "Usage: This function is designed to accept its argument, ACTM-SEQR, either as a single symbol or as a list of symbols. (company-launch 'go) (company-launch '(go)) (company-launch '(nogo go)) But it explicitly avoids supporting multiple symbols passed in a flat series. For instance, the following would not work: (company-launch 'nogo 'go) If multiple symbols are passed, they are interpreted as separate arguments, which violates the function's signature (ACTM-SEQR) and results in an error." "Usage of `company-launch'.") (defun company-launch (actm-seqr) ;; =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (:documentation (concat "Launch company-mode globally. ACTM-SEQR Action message sequencer. CASE 'go Enable `company-mode' globally by calling `global-company-mode'. 'nogo Do not enable `company-mode'." company-launch-qtr-doc)) ;; =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D= =3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D (add-hook 'after-init-hook 'global-company-mode) (message "Something something."))