bug#25603: 24.5; doc of `woman'

bug#25603: 24.5; doc of `woman'

[Drew Adams]

The doc string says this:

 The directory expansions and topics are cached for
 speed, but a non-nil interactive argument forces the caches to be
 updated (e.g. to re-interpret the current directory).

That ("a non-nil interactive argument") is not the way Emacs talks about
the prefix argument.  The doc should say that if you use a prefix
argument then the cached is updated.

Essentially, "non-nil interactive argument" should be "prefix argument".

In GNU Emacs 24.5.1 (i686-pc-mingw32)
 of 2015-04-11 on LEG570
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --prefix=/c/usr --host=i686-pc-mingw32'

bug#25603: 24.5; doc of `woman'

[npostavs]

tags 25603 fixed
close 25603 25.2
quit

Drew Adams <drew.adams@oracle.com> writes:

> The doc string says this:
>
>  The directory expansions and topics are cached for
>  speed, but a non-nil interactive argument forces the caches to be
>  updated (e.g. to re-interpret the current directory).
>
> That ("a non-nil interactive argument") is not the way Emacs talks about
> the prefix argument.  The doc should say that if you use a prefix
> argument then the cached is updated.
>
> Essentially, "non-nil interactive argument" should be "prefix argument".

Fixed [1: ec4226d810].

1: 2017-02-18 13:34:37 -0500 ec4226d81074751c105264a3a3383c48d0a05e41
  * lisp/woman.el (woman): Fix docstring prefix arg description.