unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
From: Jean Abou Samra <jean@abou-samra.fr>
To: mikael@djurfeldt.com
Cc: Jacob Hrbek <kreyren@rixotstudio.cz>,
	"guile-devel@gnu.org" <guile-devel@gnu.org>
Subject: Re: Feature request: Ability to document variables like defvar in elisp
Date: Fri, 4 Nov 2022 16:10:23 +0100	[thread overview]
Message-ID: <f6121906-bf76-64dd-f29a-271ee95db7af@abou-samra.fr> (raw)
In-Reply-To: <CAA2XvwLbm4k=KsduoR-wJ9+rEYB-=PYoxt=0cgV-8PQYoBpWRQ@mail.gmail.com>


[-- Attachment #1.1: Type: text/plain, Size: 486 bytes --]

Le 02/11/2022 à 11:15, Mikael Djurfeldt a écrit :
> (define a 5)
> (set-object-property! (module-variable (current-module) 'a) 
> 'documentation "The variable a contains a number.")
> ?



Why not, but I wanted to point out that variable documentation
cannot be done in a way that is consistent with procedure documentation.
It needs to be a different mechanism, tied to the module system, which
brings some restrictions (what about local variables?).

Best,
Jean



[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 236 bytes --]

  reply	other threads:[~2022-11-04 15:10 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-02  1:08 Feature request: Ability to document variables like defvar in elisp Jacob Hrbek
2022-11-02  8:28 ` Jean Abou Samra
2022-11-02 10:15   ` Mikael Djurfeldt
2022-11-04 15:10     ` Jean Abou Samra [this message]
2022-11-05  4:19   ` Jacob Hrbek

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/guile/

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

  git send-email \
    --in-reply-to=f6121906-bf76-64dd-f29a-271ee95db7af@abou-samra.fr \
    --to=jean@abou-samra.fr \
    --cc=guile-devel@gnu.org \
    --cc=kreyren@rixotstudio.cz \
    --cc=mikael@djurfeldt.com \
    /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).