From mboxrd@z Thu Jan  1 00:00:00 1970
From: Tim Landscheidt <tim@tim-landscheidt.de>
Subject: Bug: Incorrect/incomplete documentation for org-timestamp-change
Date: Sun, 05 May 2019 20:52:03 +0000
Message-ID: <87lfzkr5e4.fsf@passepartout.tim-landscheidt.de>
Mime-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([209.51.188.92]:47484)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <tim@tim-landscheidt.de>) id 1hNO7P-0000fD-Ki
	for emacs-orgmode@gnu.org; Sun, 05 May 2019 16:52:20 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <tim@tim-landscheidt.de>) id 1hNO7M-0004vz-LU
	for emacs-orgmode@gnu.org; Sun, 05 May 2019 16:52:18 -0400
Received: from andalucia.tim-landscheidt.de ([116.203.78.250]:52194
	helo=andalucia)
	by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_256_CBC_SHA1:32)
	(Exim 4.71) (envelope-from <tim@tim-landscheidt.de>)
	id 1hNO7K-0004Xr-Ky
	for emacs-orgmode@gnu.org; Sun, 05 May 2019 16:52:15 -0400
Received: from dslb-090-186-216-122.090.186.pools.vodafone-ip.de
	([90.186.216.122]:55140 helo=passepartout.tim-landscheidt.de)
	by andalucia with esmtpsa (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256)
	(Exim 4.89) (envelope-from <tim@tim-landscheidt.de>)
	id 1hNO7B-0004RJ-Tl
	for emacs-orgmode@gnu.org; Sun, 05 May 2019 22:52:05 +0200
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/emacs-orgmode/>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: "Emacs-orgmode"
	<emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
To: emacs-orgmode@gnu.org

I wanted to (and did) change a number of timestamps by a
constant.  So I found (and successfully used)
org-timestamp-change which starts with (master):

| [=E2=80=A6]
| (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
|   "Change the date in the time stamp at point.
| The date will be changed by N times WHAT.  WHAT can be `day', `month',
| `year', `minute', `second'.  If WHAT is not given, the cursor position
| in the timestamp determines what will be changed.
| When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
| [=E2=80=A6]

Incorrect is the enumeration of valid values for WHAT: 'hour
is missing and 'second is probably wrong (?).

Incomplete is the documentation for UPDOWN: I had assumed it
was the "direction" of change, but that is determined in-
stead by the sign of N.