emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tim Landscheidt <tim@tim-landscheidt.de>
To: emacs-orgmode@gnu.org
Subject: Bug: Incorrect/incomplete documentation for org-timestamp-change
Date: Sun, 05 May 2019 20:52:03 +0000	[thread overview]
Message-ID: <87lfzkr5e4.fsf@passepartout.tim-landscheidt.de> (raw)

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):

| […]
| (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\"."
| […]

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.

             reply	other threads:[~2019-05-05 20:52 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-05-05 20:52 Tim Landscheidt [this message]
2019-05-07 10:04 ` Bug: Incorrect/incomplete documentation for org-timestamp-change Nicolas Goaziou

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

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87lfzkr5e4.fsf@passepartout.tim-landscheidt.de \
    --to=tim@tim-landscheidt.de \
    --cc=emacs-orgmode@gnu.org \
    /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 public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).