unofficial mirror of help-gnu-emacs@gnu.org
 help / color / mirror / Atom feed
From: philip-agee@africamel.net
To: philip-agee@africamel.net, "Christopher Dimech" <dimech@gmx.com>
Cc: help-gnu-emacs@gnu.org
Subject: Printing as documentation
Date: Sun, 20 Jun 2021 09:52:59 +0200 (CEST)	[thread overview]
Message-ID: <ea-mime-60cef3db-6720-5aa3769b@www-8.mailo.com> (raw)
In-Reply-To: <ea-mime-60cef1a4-61a5-1f099f7b@www-8.mailo.com>

I am not sure if the *help* is working correctly because when I press on the Red Cross

to quit or press (q), although the window gets closed, the buffer remains.



From: philip-agee@africamel.net
To: Christopher Dimech <dimech@gmx.com>
Subject: Printing as documentation
Date: 20/06/2021 09:43:32 Europe/Paris
Cc: help-gnu-emacs@gnu.org

It does work.  I have found 

with-output-to-temp-buffer too.  

In addition to print there is 

insert

Any comments on how to choose between the different commands?  


From: Christopher Dimech <dimech@gmx.com>
To: philip-agee@africamel.net
Subject: Printing as documentation
Date: 20/06/2021 09:33:42 Europe/Paris
Cc: help-gnu-emacs@gnu.org

Try using

(defun typex ()
"todo docstring"
(interactive)

(with-help-window (help-buffer)
(with-current-buffer (help-buffer)
(print "test"))) )

> Sent: Sunday, June 20, 2021 at 5:54 PM
> From: philip-agee@africamel.net
> To: help-gnu-emacs@gnu.org
> Subject: Printing as documentation
>
> Have tried the following code, but is giving me > invalid function: "*help*"
> 
> 
> 
> (defun myfunc ()
>   "todo docstring"
>   (interactive)
> 
>   (setq bufr (help-buffer))
>   (print "test" bufr) )
> 
> 
> 
> 
> 
> 
> From: philip-agee@africamel.net
> To: help-gnu-emacs@gnu.org
> Subject: Printing as documentation
> Date: 20/06/2021 06:41:31 Europe/Paris
> 
> 
> When I wish to see the self documentation I use
> 
> C-h f myfunc
> 
> I get a temporary help buffer displaying the docstring for myfunc.
> 
> Is it possible to to do the same kind of thing when calling a description function "mydesc".
> so that the print function are show in a temporary  help buffer?
> 
> (defun mydesc ()
> "docstring for mydesc"
> 
> (print "The brown fox" help)
> (print "jumps over the fence" help) )
> 
> M-x mydesc
> 
> wiil then behave similar to doing
> 
> C-h f somefunc 
> 
> 
>





  reply	other threads:[~2021-06-20  7:52 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-06-20  4:41 Printing as documentation philip-agee
2021-06-20  5:54 ` philip-agee
2021-06-20  6:19   ` Emanuel Berg via Users list for the GNU Emacs text editor
2021-06-20  7:33   ` Christopher Dimech
2021-06-20  7:43     ` philip-agee
2021-06-20  7:52       ` philip-agee [this message]
2021-06-20 11:53         ` philip-agee
2021-06-20 12:34           ` Emanuel Berg via Users list for the GNU Emacs text editor
2021-06-20 22:11             ` philip-agee

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=ea-mime-60cef3db-6720-5aa3769b@www-8.mailo.com \
    --to=philip-agee@africamel.net \
    --cc=dimech@gmx.com \
    --cc=help-gnu-emacs@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
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).