Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 06:19 UTC)
Re: Proposal for SRFI 253: In-source documentation Vladimir Nikishkin (25 May 2024 06:25 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 06:59 UTC)
Re: Proposal for SRFI 253: In-source documentation Retropikzel (25 May 2024 06:40 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 06:46 UTC)
Re: Proposal for SRFI 253: In-source documentation Retropikzel (25 May 2024 07:14 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 07:32 UTC)
Re: Proposal for SRFI 253: In-source documentation Retropikzel (25 May 2024 08:19 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 09:02 UTC)
Re: Proposal for SRFI 253: In-source documentation Lassi Kortela (25 May 2024 10:04 UTC)
Re: Proposal for SRFI 253: In-source documentation Jakub T. Jankiewicz (25 May 2024 09:44 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 10:32 UTC)
Re: Proposal for SRFI 253: In-source documentation Jakub T. Jankiewicz (25 May 2024 11:36 UTC)
Re: Proposal for SRFI 253: In-source documentation Daphne Preston-Kendal (25 May 2024 11:06 UTC)
Re: Proposal for SRFI 253: In-source documentation Antero Mejr (25 May 2024 11:23 UTC)
Re: Proposal for SRFI 253: In-source documentation Daphne Preston-Kendal (25 May 2024 11:30 UTC)

Re: Proposal for SRFI 253: In-source documentation Retropikzel 25 May 2024 07:14 UTC

Do I understand correctly that this is meant for kind of "one line"
documentation not for something long form?

Not like this:

```
#?

## plus

Arguments:

- x (number)
- y (number)

Returns:

- (number) X and y added together

?#
(define plus
(lambda (x y)
   (+ x y)))
```

But like this:

```
#? Adds x and y together ?#
(define plus
   (lambda (x y)
```

Or should it be, since you mentioned docstrings, like this?:

```
(define plus
   #? Adds x and y together ?#
   (lambda (x y)
```

What happens if (read: when) I try to do this?:

```
(define plus
   #? Adds x and y together ?#
   (lambda (#?number?# x #?number?# y)
     (+ x y)))
```

On 25/05/2024 09:19, Antero Mejr wrote:
> I would like to propose a SRFI for in-source documentation (AKA
> docstrings). The syntax is similar to #| multi-line comments. The
> repository is here:
> https://github.com/pre-srfi/in-source-documentation
>
> Thanks!

--
- Retropikzel

https://retropikzel.kapsi.fi