* First line should describe the file, not Guix
@ 2023-07-03 7:01 McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-06 0:48 ` McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-16 13:33 ` Ludovic Courtès
0 siblings, 2 replies; 3+ messages in thread
From: McSinyx via Development of GNU Guix and the GNU System distribution. @ 2023-07-03 7:01 UTC (permalink / raw)
To: guix-devel
Hello Guix,
All Scheme source file in Guix starts with
> ;;; GNU Guix --- Functional package management for GNU
which is definitely the first thing one looks for right
after openning one. For example, when I look into aa.scm,
I need to know whether it is for _ambiguous abbreviations_
or _any another_ stuff.
I suggest changing the first line into describing the source file,
which goes in hand with
> This file is part of GNU Guix.
Is there any reason against this that I'm not aware of?
Best regards,
McSinyx
^ permalink raw reply [flat|nested] 3+ messages in thread
* First line should describe the file, not Guix
2023-07-03 7:01 First line should describe the file, not Guix McSinyx via Development of GNU Guix and the GNU System distribution.
@ 2023-07-06 0:48 ` McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-16 13:33 ` Ludovic Courtès
1 sibling, 0 replies; 3+ messages in thread
From: McSinyx via Development of GNU Guix and the GNU System distribution. @ 2023-07-06 0:48 UTC (permalink / raw)
To: guix-devel
Hello Guix,
All Scheme source file in Guix starts with
> ;;; GNU Guix --- Functional package management for GNU
which is definitely the first thing one looks for right
after openning one. For example, when I look into aa.scm,
I need to know whether it is for _ambiguous abbreviations_
or _any another_ stuff.
I suggest changing the first line into describing the source file,
which goes in hand with
> This file is part of GNU Guix.
Is there any reason against this that I'm not aware of?
Best regards,
McSinyx
^ permalink raw reply [flat|nested] 3+ messages in thread
* Re: First line should describe the file, not Guix
2023-07-03 7:01 First line should describe the file, not Guix McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-06 0:48 ` McSinyx via Development of GNU Guix and the GNU System distribution.
@ 2023-07-16 13:33 ` Ludovic Courtès
1 sibling, 0 replies; 3+ messages in thread
From: Ludovic Courtès @ 2023-07-16 13:33 UTC (permalink / raw)
To: McSinyx via Development of GNU Guix and the GNU System distribution.
Cc: McSinyx
Hi,
"McSinyx" via "Development of GNU Guix and the GNU System distribution."
<guix-devel@gnu.org> skribis:
> I suggest changing the first line into describing the source file,
> which goes in hand with
I agree in principle (this is what many GNU packages would traditionally
do), but there are many files in Guix these days… Maybe a good exercise
for someone who’s taken a guided tour of the code such as
<https://10years.guix.gnu.org/video/guixy-guile-the-derivation-factory-a-tour-of-the-guix-source-tree/>?
Thanks,
Ludo’.
^ permalink raw reply [flat|nested] 3+ messages in thread
end of thread, other threads:[~2023-07-16 13:33 UTC | newest]
Thread overview: 3+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-07-03 7:01 First line should describe the file, not Guix McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-06 0:48 ` McSinyx via Development of GNU Guix and the GNU System distribution.
2023-07-16 13:33 ` Ludovic Courtès
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/guix.git
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).