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: Adding documentation construct to display text in a defvar or defconst without the header Date: Wed, 11 Dec 2024 11:57:10 +0000 Message-ID: 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="23130"; 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 Wed Dec 11 12:57:59 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 1tLLLr-0005nN-Ko for geh-help-gnu-emacs@m.gmane-mx.org; Wed, 11 Dec 2024 12:57:59 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1tLLLG-0007Rl-4g; Wed, 11 Dec 2024 06:57:22 -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 1tLLLE-0007Rc-MV for help-gnu-emacs@gnu.org; Wed, 11 Dec 2024 06:57:20 -0500 Original-Received: from mail-10699.protonmail.ch ([79.135.106.99]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1tLLLC-0002qp-IH for help-gnu-emacs@gnu.org; Wed, 11 Dec 2024 06:57:20 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=protonmail.com; s=protonmail3; t=1733918235; x=1734177435; bh=WtTPOx5cP/SeXY4yMoRSSLGA+k67kXcQK5Do656A5QM=; 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=AbNkH36tBIC0Dp/GewI1Hjdk5Ogjjxm+NLLWaPKZcuO+YJpj36gwF/L8k2O/dU8+0 79dta3RLBUx+BgXuDa2oZ4DPZu8g88bnonqxdU7retAHJOaplJGr/Px4wsY8QhU7Im RlZLL/hFu9rWV3hZ7MoPK1SIF4tl6viRzrjKo+klt11Kotf8Y3212qGIjWcRTCOfXK 79FMmOeFGjPez3ysAVGxQ9jKyV31NcQDTs/UNBTBzT0RKfBmLlgtywgPCzH9mq3li4 Jrsr79H8Hj2gu1L6EmhJOtbt0dhXo8/IVRjJPXXThNGxZKPo2XzMcP8XcyhLA5Yrnq Hmc3rUz7VShBQ== Feedback-ID: 57735886:user:proton X-Pm-Message-ID: b6e3dc18f03b376b19eaa988465e32de14269ed2 Received-SPF: pass client-ip=79.135.106.99; envelope-from=heimeborgia@protonmail.com; helo=mail-10699.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:148756 Archived-At: Currently I cannot allow users to dynamically change the documentation=20 with different levels of detail. For instance the following will not update the documentation string when navaid-level is changed. companiol-dlv* being strings. (defun companiol-launch () =20 (:documentation (concat "Something" (when (>=3D navaid-level 1) (concat "\n\n" companiol-dlvsec)) (when (>=3D navaid-level 2) (concat "\n\n" companiol-dlvtri)) (when (>=3D navaid-level 3) (concat "\n\n" companiol-dlvqtr)))) But I could do the following (defun companiol-launch () "Something Additional information `companiol-dlvsec' Usage informantion `companiol-dlvtri' How to install company library `companiol-dlvqtr' Implementation details" Thus, when the user clicks upon companiol-dlvsec ho gets the information stored in a defconst about usage informantion. And so on. The problem that is encountered is that one also gets the additional text -------------------------------------------------------------------------- companiol-dlvsec is a variable defined in =E2=80=98componiol.el=E2=80=99. Its value is shown below. Description of call sequence of =E2=80=98companiol-launch=E2=80=99. Value: --------------------------------------------------------------------------- To allow me to display the additional information, I do not want the additi= onal text to be displayed, but display just the string. Perhaps a new construct= could be allowed in the docstring so that the variable displayed for a string doe= s not=20 display the additional text, but consider the string as additional document= ation detail. =20