From: Eli Zaretskii <eliz@gnu.org>
To: Damien Cassou <damien@cassou.me>
Cc: 58071@debbugs.gnu.org
Subject: bug#58071: 28.2; [PATCH] jumprel: A tool to find/create related files
Date: Fri, 30 Sep 2022 13:38:05 +0300 [thread overview]
Message-ID: <83o7uxdu5u.fsf@gnu.org> (raw)
In-Reply-To: <87czbd8d6j.fsf@cassou.me> (message from Damien Cassou on Fri, 30 Sep 2022 10:43:48 +0200)
> From: Damien Cassou <damien@cassou.me>
> Cc: 58071@debbugs.gnu.org
> Date: Fri, 30 Sep 2022 10:43:48 +0200
>
> Eli Zaretskii <eliz@gnu.org> writes:
> > I guess the doc string of jumprel-jumpers would be a possibility.
>
> `jumprel-jumpers' is in jumprel.el which is independent of
> jumprel-recipe.el. I would like to keep the responsibility clean if
> possible.
jumprel-recipe.el is AFAICT devoid of any recipe-related public APIs,
so I don't see how such a separation can be possible. I also question
the motivation: is jumprel.el really independent of the inner workings
of the recipes as implemented in jumprel-recipe.el? The interface
doesn't seem to me abstract enough to justify the separation. Even if
I did agree that documentation must always be in the same place as the
code. Which I don't necessarily agree with: there are many examples
when documentation and implementation are physically on different
files.
Anyway, you asked for suggestions, and I gave you one. I still think
there's nothing wrong with it, but feel free to add the documentation
in some other place which looks more correct to you.
next prev parent reply other threads:[~2022-09-30 10:38 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-25 11:20 bug#58071: 28.2; [PATCH] jumprel: A tool to find/create related files Damien Cassou
2022-09-26 7:42 ` Eli Zaretskii
2022-09-28 19:26 ` Damien Cassou
2022-09-29 8:54 ` Eli Zaretskii
2022-09-30 8:43 ` Damien Cassou
2022-09-30 10:38 ` Eli Zaretskii [this message]
2022-09-29 10:46 ` Lars Ingebrigtsen
2022-09-30 8:44 ` Damien Cassou
2022-10-06 6:09 ` Damien Cassou
2022-09-26 11:05 ` Lars Ingebrigtsen
2022-09-26 13:37 ` Stefan Kangas
2022-09-27 11:34 ` Lars Ingebrigtsen
2022-10-28 22:08 ` hugo
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/emacs/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83o7uxdu5u.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=58071@debbugs.gnu.org \
--cc=damien@cassou.me \
/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.
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.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).