bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#35163: 25.1; `narrow-to-region' docstring no mention of args


From: Eli Zaretskii
Subject: bug#35163: 25.1; `narrow-to-region' docstring no mention of args
Date: Sat, 06 Apr 2019 09:25:17 +0300

> From: Emanuel Berg <moasenwood@zoho.eu>
> Cc: 35163@debbugs.gnu.org
> Date: Fri, 05 Apr 2019 21:26:55 +0200
> 
> Eli Zaretskii wrote:
> 
> >> From: Emanuel Berg <moasenwood@zoho.eu>
> >> Date: Fri, 05 Apr 2019 20:51:37 +0200
> >> 
> >> 25.1; `narrow-to-region' docstring no
> >> mention of args
> >> 
> >> The `narrow-to-region' docstring does not
> >> mention its arguments as is the norm.
> >
> > It does:
> >
> > When calling from a program, pass two
> > arguments; positions (integers or markers)
> > bounding the text that should remain visible.
> 
> The words START and END do not appear, in that
> order, in the docstring. Actually, they don't
> appear at all. That means they are
> not searchable.

This is a command, first and foremost.  The primary goal of its doc
string is to tell users (not Lisp programmers) how to use the command
and what it does.  In interactive usage, START and END come from the
region and are not under user control explicitly.

So I don't think there's anything wrong with this doc string.





reply via email to

[Prev in Thread] Current Thread [Next in Thread]