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

Previous Next

Full log

Message #14 received at 35163 <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Emanuel Berg <moasenwood <at> zoho.eu>
Cc: 35163 <at> debbugs.gnu.org
Subject: Re: 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 <at> zoho.eu>
> Cc: 35163 <at> debbugs.gnu.org
> Date: Fri, 05 Apr 2019 21:26:55 +0200
> 
> Eli Zaretskii wrote:
> 
> >> From: Emanuel Berg <moasenwood <at> 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.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.