GNU bug report logs - #56483
Request to append string to the documentation of a function

Previous Next

Package: emacs;

Reported by: carlmarcos <at> tutanota.com

Date: Sun, 10 Jul 2022 15:21:02 UTC

Severity: minor

Tags: notabug

Done: Lars Ingebrigtsen <larsi <at> gnus.org>

Bug is archived. No further changes may be made.

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 56483 in the body.
You can then email your comments to 56483 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

View this report as an mbox folder, status mbox, maintainer mbox

Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#56483; Package emacs. (Sun, 10 Jul 2022 15:21:02 GMT) Full text and rfc822 format available.
Acknowledgement sent to carlmarcos <at> tutanota.com:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Sun, 10 Jul 2022 15:21:02 GMT) Full text and rfc822 format available.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: carlmarcos <at> tutanota.com
To: Bug Gnu Emacs <bug-gnu-emacs <at> gnu.org>
Subject: Request to append string to the documentation of a function
Date: Sun, 10 Jul 2022 17:20:30 +0200 (CEST)

[Message part 1 (text/plain, inline)]
Currently I am appending a string `str` to the documentation of a function `myfun` using

(put myfun 'function-documentation
       (concat
          (documentation myfun t)
           str)

Whilst the strategy works, this requires adding `str` after the function `myfun` has been defined.
Does there exist the possibility to add `str` directly inside the docstring of the function when I am
defining the function itself, avoiding the `(put` command mentioned earlier after the implementation
of the function myfun? 

[Message part 2 (text/html, inline)]
Information forwarded to bug-gnu-emacs <at> gnu.org:
bug#56483; Package emacs. (Mon, 11 Jul 2022 10:06:01 GMT) Full text and rfc822 format available.

Message #8 received at 56483 <at> debbugs.gnu.org (full text, mbox):

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: carlmarcos <at> tutanota.com
Cc: 56483 <at> debbugs.gnu.org
Subject: Re: bug#56483: Request to append string to the documentation of a
 function
Date: Mon, 11 Jul 2022 12:05:25 +0200

carlmarcos <at> tutanota.com writes:

> Whilst the strategy works, this requires adding `str` after the
> function `myfun` has been defined.  Does there exist the possibility
> to add `str` directly inside the docstring of the function when I am
> defining the function itself, avoiding the `(put` command mentioned
> earlier after the implementation of the function myfun?

You can make a macro around `defalias'.  In any case, this is not an
Emacs bug -- if you need help using Emacs, use one of the appropriate
mailing lists for that.

Closing.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no
Added tag(s) notabug. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 11 Jul 2022 10:06:01 GMT) Full text and rfc822 format available.
bug closed, send any further explanations to 56483 <at> debbugs.gnu.org and carlmarcos <at> tutanota.com Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Mon, 11 Jul 2022 10:06:02 GMT) Full text and rfc822 format available.
bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Mon, 08 Aug 2022 11:24:09 GMT) Full text and rfc822 format available.
This bug report was last modified 2 years and 316 days ago.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.