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
This commit is contained in:
Juanma Barranquero 2019-09-19 04:32:25 +02:00 committed by Kyle Meyer
parent 97c14ca8cd
commit 001306c1c0
7 changed files with 10 additions and 10 deletions

View File

@ -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 If FIXFACE is non-nil, the face of each item is modified according to
the new TODO state. the new TODO state.
If JUST-THIS is non-nil, change just the current line, not all. 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) (let* ((inhibit-read-only t)
(line (org-current-line)) (line (org-current-line))
(org-agenda-buffer (current-buffer)) (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" ""))))) (message "Added %d event%s for today" cnt (if (> cnt 1) "s" "")))))
(defun org-agenda-today-p (date) (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 DATE is either a list of the form (month day year) or a number of
days as returned by `calendar-absolute-from-gregorian' or days as returned by `calendar-absolute-from-gregorian' or
`org-today'. This function considers `org-extend-today-until' `org-today'. This function considers `org-extend-today-until'

View File

@ -242,7 +242,7 @@ Create an ID if necessary."
"Get the ID property of the entry at point-or-marker POM. "Get the ID property of the entry at point-or-marker POM.
If POM is nil, refer to the entry at point. If POM is nil, refer to the entry at point.
If the entry does not have an ID, the function returns nil. 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'. PREFIX will be passed through to `org-id-new'.
In any case, the ID of the entry is returned." In any case, the ID of the entry is returned."
(org-with-point-at pom (org-with-point-at pom

View File

@ -4281,7 +4281,7 @@ org-level-* faces."
(defcustom org-highlight-latex-and-related nil (defcustom org-highlight-latex-and-related nil
"Non-nil means highlight LaTeX related syntax in the buffer. "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: following symbols:
`latex' Highlight LaTeX snippets and environments. `latex' Highlight LaTeX snippets and environments.
`script' Highlight subscript and superscript. `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.") Being in this list makes sure that they are offered for completion.")
(defun org--valid-property-p (property) (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 (not
(or (equal property "") (or (equal property "")
(string-match-p "\\s-" property)))) (string-match-p "\\s-" property))))

View File

@ -326,7 +326,7 @@ INFO is a plist used as a communication channel.
The value is either the label specified in \"BEAMER_opt\" The value is either the label specified in \"BEAMER_opt\"
property, the custom ID, if there is one and 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 a unique internal label. This function assumes HEADLINE will be
treated as a frame." treated as a frame."
(cond (cond

View File

@ -1236,7 +1236,7 @@ calling `org-latex-compile'."
;;; Internal Functions ;;; Internal Functions
(defun org-latex--caption-above-p (element info) (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." INFO is a plist holding contextual information."
(let ((above (plist-get info :latex-caption-above))) (let ((above (plist-get info :latex-caption-above)))
(if (symbolp above) above (if (symbolp above) above

View File

@ -2176,7 +2176,7 @@ SHORT-CAPTION are strings."
;;;; Links :: Inline Images ;;;; Links :: Inline Images
(defun org-odt--copy-image-file (path) (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)) (let* ((image-type (file-name-extension path))
(media-type (format "image/%s" image-type)) (media-type (format "image/%s" image-type))
(target-dir "Images/") (target-dir "Images/")
@ -2381,7 +2381,7 @@ used as a communication channel."
(concat equation "<text:tab/>" label)))))) (concat equation "<text:tab/>" label))))))
(defun org-odt--copy-formula-file (src-file) (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/" (let* ((target-dir (format "Formula-%04d/"
(cl-incf org-odt-embedded-formulas-count))) (cl-incf org-odt-embedded-formulas-count)))
(target-file (concat target-dir "content.xml"))) (target-file (concat target-dir "content.xml")))

View File

@ -804,7 +804,7 @@ also be set with the OPTIONS keyword, e.g. \"timestamp:nil\"."
:safe #'booleanp) :safe #'booleanp)
(defcustom org-export-with-timestamps t (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: It can be set to any of the following values:
t export all timestamps. t export all timestamps.