Skip to content

Commit

Permalink
lisp/org-macs.el: Minor docstring enhancements
Browse files Browse the repository at this point in the history
* lisp/org-macs.el (org-assert-version): Minor docstring enhancements.
  • Loading branch information
bzg committed Sep 25, 2022
1 parent 6b729e2 commit fd19526
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions lisp/org-macs.el
Original file line number Diff line number Diff line change
Expand Up @@ -37,17 +37,18 @@
;;; Org version verification.

(defmacro org-assert-version ()
"Assert compile time and runtime verstion match."
"Assert compile time and runtime version match."
`(unless (equal (org-git-version) ,(org-git-version))
(warn "Org version mismatch. Make sure that correct `load-path' is set early in init.el
This warning usually appears when a built-in Org version is loaded
prior to the more recent Org version.
Version mismatch is commonly encountered in the following situations:
1. Emacs is loaded using literate Org config and more recent Org
version is loaded inside the file loaded by `org-babel-load-file'.
`org-babel-load-file' triggers the built-in Org version clashing
the newer Org version attempted to be loaded later.
the newer Org version attempt to be loaded later.
It is recommended to move the Org loading code before the
`org-babel-load-file' call.
Expand Down

0 comments on commit fd19526

Please sign in to comment.