unofficial mirror of guile-devel@gnu.org 
 help / color / mirror / Atom feed
* Feature request: Ability to document variables like defvar in elisp
@ 2022-11-02  1:08 Jacob Hrbek
  2022-11-02  8:28 ` Jean Abou Samra
  0 siblings, 1 reply; 5+ messages in thread
From: Jacob Hrbek @ 2022-11-02  1:08 UTC (permalink / raw)
  To: guile-devel@gnu.org

[-- Attachment #1: Type: text/plain, Size: 889 bytes --]

The ability to document variables is critical for many projects such as libfive where the variables is used to declares functional computer aided design structure and other projects where variables influence the workflow.

Thus proposing to change the 'define' behavior for variables to implement:

(define variable default-value docstring)
^^^^^^

Where docstring is optional and in case it's provided to call for example:

(set-procedure-property! variable 'documentation docstring)

So that it can be called from (help variable):

scheme@(guile-user)> (help variable)
`variable' is a procedure in the (guile) module.
expanded docstring here

This way it will also make it possible to easily implement development environment that shows the documentation on cursor hover.

---

Credit: Inspired by 'defvar' from elisp:

(defvar variable default-value docstring)

-- Jacob "Kreyren" Hrbek

[-- Attachment #2: Type: text/html, Size: 1598 bytes --]

^ permalink raw reply	[flat|nested] 5+ messages in thread

end of thread, other threads:[~2022-11-05  4:19 UTC | newest]

Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
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
2022-11-05  4:19   ` Jacob Hrbek

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).