branch: elpa/annotate
commit 754db391fd19da3e17d115b0feead2ea0134f872
Author: cage <cage-invalid@invalid>
Commit: cage <cage-invalid@invalid>
- updated section 'known bugs' of README.
---
Changelog | 4 ++++
NEWS.org | 3 +++
README.org | 35 +++++++++++++++++++++++++++--------
annotate.el | 4 ++--
4 files changed, 36 insertions(+), 10 deletions(-)
diff --git a/Changelog b/Changelog
index 1fb758125c..91ba11569b 100644
--- a/Changelog
+++ b/Changelog
@@ -1,3 +1,7 @@
+2020-06-24 Bastian Bechtold, cage
+ * README.org
+ - Updated the "Known bugs" section of README.
+
2020-06-09 Bastian Bechtold, cage
* annotate.el (annotate-buffers-annotate-mode, annotate-switch-db)
- added functions to switch the database of annotations used for the
emacs session;
diff --git a/NEWS.org b/NEWS.org
index cbbce9065c..bceea223bd 100644
--- a/NEWS.org
+++ b/NEWS.org
@@ -117,3 +117,6 @@
- 2020-06-09 V0.8.0 Bastian Bechtold, cage ::
The database of annotation can be changed using the command
~annotate-switch-db~.
+
+- 2020-06-24 V0.8.1 Bastian Bechtold, cage ::
+ Updated the ~Known bugs~ section of ~README~.
diff --git a/README.org b/README.org
index 19c655be97..3991a53bab 100644
--- a/README.org
+++ b/README.org
@@ -117,16 +117,35 @@ as comments into the current buffer, like this:
** Known bugs
- Annotations in org-mode source blocks will be underlined, but the
- annotations don't show up. This is likely a fundamental
- incompatibility with the way source blocks are highlighted and the
- way annotations are displayed.
+ - Annotations in org-mode source blocks will be underlined, but the
+ annotations don't show up. This is likely a fundamental
+ incompatibility with the way source blocks are highlighted and the
+ way annotations are displayed.
- Annotating a region that contains newline(s) can results in various
- issues.
+ - ~scroll-down-line~ could get stuck on a annotated line. In this
+ case a workaround is to call the command with a numeric prefix
+ equals to one plus the number of annotation text lines below the
+ annotated text.
- Deleting the first character of an annotated text will remove the
- annotation (this turned out to be useful, though).
+ For example:
+
+ #+BEGIN_SRC text
+ foo bar baz
+ annotation
+ #+END_SRC
+
+ needs a prefix of 2: ~C-u 2 M-x scroll-down-line~
+
+ But note that:
+
+ #+BEGIN_SRC text
+ foo bar baz annotation
+ #+END_SRC
+
+ Needs no prefix.
+
+ - Deleting the first character of an annotated text will remove the
+ annotation (this turned out to be useful, though).
** Report bugs
diff --git a/annotate.el b/annotate.el
index 84789fcc5d..e70f22e9fa 100644
--- a/annotate.el
+++ b/annotate.el
@@ -7,7 +7,7 @@
;; Maintainer: Bastian Bechtold
;; URL: https://github.com/bastibe/annotate.el
;; Created: 2015-06-10
-;; Version: 0.8.0
+;; Version: 0.8.1
;; This file is NOT part of GNU Emacs.
@@ -55,7 +55,7 @@
;;;###autoload
(defgroup annotate nil
"Annotate files without changing them."
- :version "0.8.0"
+ :version "0.8.1"
:group 'text)
;;;###autoload
