branch: externals/excorporate
commit 85b5e8481f48fa9bfbf9ee84549e73327063d5d4
Author: Thomas Fitzsimmons <fitz...@fitzsim.org>
Commit: Thomas Fitzsimmons <fitz...@fitzsim.org>
Document API and UI stability
* excorporate.el (exco-api-version): Remove subject-to-change
sentence from docstring.
* excorporate-calendar.el: Update copyright years.
(calendar-mode-map): Remove comment about possible change.
* excorporate.texi (API Usage): Declare 1.0.0 API stable.
* excorporate.info: Regenerate.
---
excorporate-calendar.el | 4 +---
excorporate.el | 3 +--
excorporate.info | 7 ++++++-
excorporate.texi | 6 ++++++
4 files changed, 14 insertions(+), 6 deletions(-)
diff --git a/excorporate-calendar.el b/excorporate-calendar.el
index 506ac72..aaf7691 100644
--- a/excorporate-calendar.el
+++ b/excorporate-calendar.el
@@ -1,6 +1,6 @@
;;; excorporate-calendar.el --- Exchange for calendar -*- lexical-binding: t
-*-
-;; Copyright (C) 2014-2016 Free Software Foundation, Inc.
+;; Copyright (C) 2014-2021 Free Software Foundation, Inc.
;; Author: Thomas Fitzsimmons <fitz...@fitzsim.org>
;; Keywords: calendar
@@ -37,8 +37,6 @@
(interactive)
(apply excorporate-calendar-show-day-function (calendar-cursor-to-date t)))
-;; I arrogantly claim "e" for now, but irresponsibly reserve the right
-;; to change it later.
(define-key calendar-mode-map "e" #'exco-calendar-show-day)
(provide 'excorporate-calendar)
diff --git a/excorporate.el b/excorporate.el
index 29ba962..51a55a1 100644
--- a/excorporate.el
+++ b/excorporate.el
@@ -633,8 +633,7 @@ IDENTIFIER."
(defun exco-api-version ()
"Return the Excorporate API version.
Return a non-negative integer representing the current
-Excorporate application programming interface version. Version 0
-is subject to change."
+Excorporate application programming interface version."
0)
(defun exco-connect (identifier)
diff --git a/excorporate.info b/excorporate.info
index fb14e79..6e30e02 100644
--- a/excorporate.info
+++ b/excorporate.info
@@ -277,6 +277,11 @@ File: excorporate.info, Node: API Usage, Next: Index,
Prev: Troubleshooting,
6 API Usage
***********
+As of version 1.0.0, the Excorporate API is declared stable. The
+function 'exco-api-version' will return 0, meaning API version 0. In
+the unlikely event that compatibility needs to be broken, the API
+version will be incremented.
+
Here are some examples of using the API (application programming
interface) provided by Excorporate.
@@ -779,7 +784,7 @@ Node: Configuration3007
Node: Usage4079
Node: Troubleshooting6538
Node: API Usage10221
-Node: Index27583
+Node: Index27815
End Tag Table
diff --git a/excorporate.texi b/excorporate.texi
index 5997e0d..162c416 100644
--- a/excorporate.texi
+++ b/excorporate.texi
@@ -310,6 +310,12 @@ it.
@chapter API Usage
@noindent
+As of version 1.0.0, the Excorporate API is declared stable. The
+function @code{exco-api-version} will return 0, meaning API version 0.
+In the unlikely event that compatibility needs to be broken, the API
+version will be incremented.
+
+@noindent
Here are some examples of using the API (application programming
interface) provided by Excorporate.
