From: Eli Zaretskii <eliz@gnu.org>
To: Sean Whitton <spwhitton@spwhitton.name>
Cc: philipk@posteo.net, emacs-devel@gnu.org
Subject: Re: New optional Eshell module: em-elecslash
Date: Sat, 16 Apr 2022 22:18:05 +0300 [thread overview]
Message-ID: <83ee1wzvki.fsf@gnu.org> (raw)
In-Reply-To: <87k0bokg98.fsf@melete.silentflame.com> (message from Sean Whitton on Sat, 16 Apr 2022 11:57:55 -0700)
> From: Sean Whitton <spwhitton@spwhitton.name>
> Date: Sat, 16 Apr 2022 11:57:55 -0700
>
> Here is my new module, which I'd like to install on master.
Thanks, a few comments below regarding the documentation parts.
> >From c915c51cd32b6354b951f10fb4d2d3666b3480d2 Mon Sep 17 00:00:00 2001
> From: Sean Whitton <spwhitton@spwhitton.name>
> Date: Sat, 16 Apr 2022 08:23:14 -0700
> Subject: [PATCH] New electric forward slash Eshell module
>
> * lisp/eshell/em-elecslash.el: New module.
We use "New file."
> +This optional module tries to help with passing absolute paths to
GNU Coding Standards frown on using "path" for anything but PATH-style
directory lists. In other cases, we use "file name" instead. Please
correct this terminology here and elsewhere in the patch.
> +passed to Lisp functions must have Tramp's @code{/method:host:}
^^^^^^^^^^^^^^^^^^^^
File names should have the @file markup.
> +@noindent and in reviewing the output of the command, you identify a
> +file @code{/etc/gnugnu} that should be moved somewhere else. So you
^^^^^^^^^^^^^^^^^^
Likewise (and elsewhere in the patch).
> +@noindent But since @code{mv} refers to the local Lisp function
^^^^^^^^^
"mv" is a command, so it should use the @command markup.
> +If the @code{eshell-elecslash} module has been added to
> +@code{eshell-modules-list}, and @code{default-directory} is remote,
> +then when you type the first forward slash of an argument to a Lisp
> +function, the Tramp prefix will be filled in for you. A second
> +forward slash can be used to undo the insertion, for when you really
> +do want to pass a local absolute path, such as when you want to copy a
> +remote file to the local machine. And when typing arguments to
> +external commands, the Tramp prefix is not filled in. The result is
> +that you don't have to think about inserting the Tramp prefix and can
> +just type absolute paths in the same way for both types of command.
> +The Tramp prefix is additionally filled in when you type @code{~/}.
You use passive tense a lot (here and elsewhere), which in many cases
makes the text longer, more complicated, and harder to understand.
Please try rephrasing without using passive tense so much.
> +*** New optional Eshell module to help avoid mistakes when supplying
The first line of a NEWS entry is a heading, so it should be a
complete sentence, to facilitate reading the outlines.
> +;;;###autoload
> +(progn
> +(defgroup eshell-elecslash nil
> + "When `default-directory' is remote thanks to Eshell's TRAMP
the first line of a doc string should be a complete sentence, because
some Help commands only show that single line.
> +(defun eshell-electric-forward-slash ()
> + "Electric insertion of TRAMP part of `default-directory' in
> +remote Eshells. Added to `post-self-insert-hook' when the
Likewise.
next prev parent reply other threads:[~2022-04-16 19:18 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-27 2:48 Optional Eshell modules -- to emacs.git or ELPA? Sean Whitton
2022-01-29 11:51 ` Philip Kaludercic
2022-04-16 18:57 ` New optional Eshell module: em-elecslash Sean Whitton
2022-04-16 19:18 ` Eli Zaretskii [this message]
2022-04-16 20:04 ` Sean Whitton
2022-04-16 21:42 ` [External] : " Drew Adams
2022-04-17 6:20 ` Eli Zaretskii
2022-04-17 16:48 ` [External] : " Drew Adams
2022-04-19 16:52 ` Sean Whitton
2022-04-20 0:36 ` Sean Whitton
2022-04-20 6:19 ` Eli Zaretskii
2022-04-20 20:14 ` Sean Whitton
2022-04-21 6:15 ` Eli Zaretskii
2022-04-16 21:12 ` Sean Whitton
2022-04-16 22:58 ` Stefan Monnier
2022-04-17 5:02 ` Sean Whitton
2022-04-17 6:24 ` Jim Porter
2022-04-19 15:28 ` Sean Whitton
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=83ee1wzvki.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=emacs-devel@gnu.org \
--cc=philipk@posteo.net \
--cc=spwhitton@spwhitton.name \
/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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.