From 001306c1c04c2d1cbc571df240af771bdd3f04df Mon Sep 17 00:00:00 2001 From: Juanma Barranquero Date: Thu, 19 Sep 2019 04:32:25 +0200 Subject: [PATCH] Backport commit 79a01866a from Emacs * lisp/org-agenda.el (org-agenda-change-all-lines) (org-agenda-today-p): * lisp/org-id.el (org-id-get): * lisp/org.el (org-highlight-latex-and-related) (org--valid-property-p): * lisp/ox-beamer.el (org-beamer--get-label): * lisp/ox-latex.el (org-latex--caption-above-p): * lisp/ox-odt.el (org-odt--copy-image-file) (org-odt--copy-formula-file): * lisp/ox.el (org-export-with-timestamps): Fix typos in docstrings. lisp/*.el, src/*.c: Fix typos in docstrings 79a01866a01754b9f566af76ef96e80cd90d094b Juanma Barranquero Thu Sep 19 04:32:25 2019 +0200 --- lisp/org-agenda.el | 4 ++-- lisp/org-id.el | 2 +- lisp/org.el | 4 ++-- lisp/ox-beamer.el | 2 +- lisp/ox-latex.el | 2 +- lisp/ox-odt.el | 4 ++-- lisp/ox.el | 2 +- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el index 76ff2d98a..22cf7d138 100644 --- a/lisp/org-agenda.el +++ b/lisp/org-agenda.el @@ -8943,7 +8943,7 @@ The new content of the line will be NEWHEAD (as modified by If FIXFACE is non-nil, the face of each item is modified according to the new TODO state. If JUST-THIS is non-nil, change just the current line, not all. -If FORCE-TAGS is non nil, the car of it returns the new tags." +If FORCE-TAGS is non-nil, the car of it returns the new tags." (let* ((inhibit-read-only t) (line (org-current-line)) (org-agenda-buffer (current-buffer)) @@ -10256,7 +10256,7 @@ to override `appt-message-warning-time'." (message "Added %d event%s for today" cnt (if (> cnt 1) "s" ""))))) (defun org-agenda-today-p (date) - "Non nil when DATE means today. + "Non-nil when DATE means today. DATE is either a list of the form (month day year) or a number of days as returned by `calendar-absolute-from-gregorian' or `org-today'. This function considers `org-extend-today-until' diff --git a/lisp/org-id.el b/lisp/org-id.el index 52fce5468..ee1316511 100644 --- a/lisp/org-id.el +++ b/lisp/org-id.el @@ -242,7 +242,7 @@ Create an ID if necessary." "Get the ID property of the entry at point-or-marker POM. If POM is nil, refer to the entry at point. If the entry does not have an ID, the function returns nil. -However, when CREATE is non nil, create an ID if none is present already. +However, when CREATE is non-nil, create an ID if none is present already. PREFIX will be passed through to `org-id-new'. In any case, the ID of the entry is returned." (org-with-point-at pom diff --git a/lisp/org.el b/lisp/org.el index aa83e5b8b..8d2aadc86 100644 --- a/lisp/org.el +++ b/lisp/org.el @@ -4281,7 +4281,7 @@ org-level-* faces." (defcustom org-highlight-latex-and-related nil "Non-nil means highlight LaTeX related syntax in the buffer. -When non nil, the value should be a list containing any of the +When non-nil, the value should be a list containing any of the following symbols: `latex' Highlight LaTeX snippets and environments. `script' Highlight subscript and superscript. @@ -14934,7 +14934,7 @@ but in some other way.") Being in this list makes sure that they are offered for completion.") (defun org--valid-property-p (property) - "Non nil when string PROPERTY is a valid property name." + "Non-nil when string PROPERTY is a valid property name." (not (or (equal property "") (string-match-p "\\s-" property)))) diff --git a/lisp/ox-beamer.el b/lisp/ox-beamer.el index 05894ffab..d9d228c9a 100644 --- a/lisp/ox-beamer.el +++ b/lisp/ox-beamer.el @@ -326,7 +326,7 @@ INFO is a plist used as a communication channel. The value is either the label specified in \"BEAMER_opt\" property, the custom ID, if there is one and -`:latex-prefer-user-labels' property has a non nil value, or +`:latex-prefer-user-labels' property has a non-nil value, or a unique internal label. This function assumes HEADLINE will be treated as a frame." (cond diff --git a/lisp/ox-latex.el b/lisp/ox-latex.el index 75e6d1ecb..5fb2c430d 100644 --- a/lisp/ox-latex.el +++ b/lisp/ox-latex.el @@ -1236,7 +1236,7 @@ calling `org-latex-compile'." ;;; Internal Functions (defun org-latex--caption-above-p (element info) - "Non nil when caption is expected to be located above ELEMENT. + "Non-nil when caption is expected to be located above ELEMENT. INFO is a plist holding contextual information." (let ((above (plist-get info :latex-caption-above))) (if (symbolp above) above diff --git a/lisp/ox-odt.el b/lisp/ox-odt.el index c14ee0b6b..8f2a1d1da 100644 --- a/lisp/ox-odt.el +++ b/lisp/ox-odt.el @@ -2176,7 +2176,7 @@ SHORT-CAPTION are strings." ;;;; Links :: Inline Images (defun org-odt--copy-image-file (path) - "Returns the internal name of the file" + "Return the internal name of the file" (let* ((image-type (file-name-extension path)) (media-type (format "image/%s" image-type)) (target-dir "Images/") @@ -2381,7 +2381,7 @@ used as a communication channel." (concat equation "" label)))))) (defun org-odt--copy-formula-file (src-file) - "Returns the internal name of the file" + "Return the internal name of the file" (let* ((target-dir (format "Formula-%04d/" (cl-incf org-odt-embedded-formulas-count))) (target-file (concat target-dir "content.xml"))) diff --git a/lisp/ox.el b/lisp/ox.el index b7751a727..ec9527fba 100644 --- a/lisp/ox.el +++ b/lisp/ox.el @@ -804,7 +804,7 @@ also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"." :safe #'booleanp) (defcustom org-export-with-timestamps t - "Non nil means allow timestamps in export. + "Non-nil means allow timestamps in export. It can be set to any of the following values: t export all timestamps.