unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
* Adding documentation construct to display text in a defvar or defconst without the header
@ 2024-12-11 11:57 Heime via Users list for the GNU Emacs text editor
  0 siblings, 0 replies; only message in thread
From: Heime via Users list for the GNU Emacs text editor @ 2024-12-11 11:57 UTC (permalink / raw)
  To: Heime via Users list for the GNU Emacs text editor




Currently I cannot allow users to dynamically change the documentation 
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 ()
 
   (:documentation
     (concat "Something"

       (when (>= navaid-level 1) (concat "\n\n" companiol-dlvsec))
       (when (>= navaid-level 2) (concat "\n\n" companiol-dlvtri))
       (when (>= 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 ‘componiol.el’.

Its value is shown below.

Description of call sequence of ‘companiol-launch’.

Value:

---------------------------------------------------------------------------

To allow me to display the additional information, I do not want the additional
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 does not 
display the additional text, but consider the string as additional documentation
detail.  

















^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2024-12-11 11:57 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2024-12-11 11:57 Adding documentation construct to display text in a defvar or defconst without the header Heime via Users list for the GNU Emacs text editor

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).