branch: elpa/emacsql
commit 0bcf526c48bed7004db7ff2fdc340ce018273d3e
Author: Jonas Bernoulli <jo...@bernoul.li>
Commit: Jonas Bernoulli <jo...@bernoul.li>
Fix how class documentation is provided
Use an Emacs-style documentation string. A class option could also
be used, but those options are not wrapped in an additional list as
we previously did.
---
emacsql-mysql.el | 3 ++-
emacsql-pg.el | 2 +-
emacsql-psql.el | 2 +-
emacsql-sqlite-builtin.el | 2 +-
emacsql-sqlite-module.el | 2 +-
emacsql-sqlite.el | 2 +-
emacsql.el | 10 ++++------
7 files changed, 11 insertions(+), 12 deletions(-)
diff --git a/emacsql-mysql.el b/emacsql-mysql.el
index 87c387c1df..4b98ea6ab7 100644
--- a/emacsql-mysql.el
+++ b/emacsql-mysql.el
@@ -67,7 +67,8 @@ http://dev.mysql.com/doc/refman/5.5/en/reserved-words.html";)
:initform '((integer "BIGINT")
(float "DOUBLE")
(object "LONGTEXT")
- (nil "LONGTEXT")))))
+ (nil "LONGTEXT"))))
+ "A connection to a MySQL database.")
(cl-defun emacsql-mysql (database &key user password host port debug)
"Connect to a MySQL server using the mysql command line program."
diff --git a/emacsql-pg.el b/emacsql-pg.el
index 0f81bb6114..0a4e7da74a 100644
--- a/emacsql-pg.el
+++ b/emacsql-pg.el
@@ -39,7 +39,7 @@
(float "DOUBLE PRECISION")
(object "TEXT")
(nil "TEXT"))))
- (:documentation "A connection to a PostgreSQL database via pg.el."))
+ "A connection to a PostgreSQL database via pg.el.")
(cl-defun emacsql-pg (dbname user &key
(host "localhost") (password "") (port 5432)
debug)
diff --git a/emacsql-psql.el b/emacsql-psql.el
index fa4b1b556c..23e419b286 100644
--- a/emacsql-psql.el
+++ b/emacsql-psql.el
@@ -63,7 +63,7 @@
http://www.postgresql.org/docs/7.3/static/sql-keywords-appendix.html";)
(float "DOUBLE PRECISION")
(object "TEXT")
(nil "TEXT"))))
- (:documentation "A connection to a PostgreSQL database via psql."))
+ "A connection to a PostgreSQL database via psql.")
(cl-defun emacsql-psql (dbname &key username hostname port debug)
"Connect to a PostgreSQL server using the psql command line program."
diff --git a/emacsql-sqlite-builtin.el b/emacsql-sqlite-builtin.el
index 2bef8b11c5..2c264da913 100644
--- a/emacsql-sqlite-builtin.el
+++ b/emacsql-sqlite-builtin.el
@@ -35,7 +35,7 @@
(float "REAL")
(object "TEXT")
(nil nil))))
- (:documentation "A connection to a SQLite database using builtin support."))
+ "A connection to a SQLite database using builtin support.")
(cl-defmethod initialize-instance :after
((connection emacsql-sqlite-builtin-connection) &rest _)
diff --git a/emacsql-sqlite-module.el b/emacsql-sqlite-module.el
index 12837fbfc9..c2f5f0c2ab 100644
--- a/emacsql-sqlite-module.el
+++ b/emacsql-sqlite-module.el
@@ -37,7 +37,7 @@
(float "REAL")
(object "TEXT")
(nil nil))))
- (:documentation "A connection to a SQLite database using a module."))
+ "A connection to a SQLite database using a module.")
(cl-defmethod initialize-instance :after
((connection emacsql-sqlite-module-connection) &rest _)
diff --git a/emacsql-sqlite.el b/emacsql-sqlite.el
index f15068ad6e..e2cb39338d 100644
--- a/emacsql-sqlite.el
+++ b/emacsql-sqlite.el
@@ -64,7 +64,7 @@ used.")
(float "REAL")
(object "TEXT")
(nil nil))))
- (:documentation "A connection to a SQLite database."))
+ "A connection to a SQLite database.")
(cl-defmethod initialize-instance :after
((connection emacsql-sqlite-connection) &rest _rest)
diff --git a/emacsql.el b/emacsql.el
index 8c4da41e8c..e755b8cc55 100644
--- a/emacsql.el
+++ b/emacsql.el
@@ -98,7 +98,7 @@ If nil, wait forever.")
:initform nil
:reader emacsql-types
:documentation "Maps EmacSQL types to SQL types."))
- (:documentation "A connection to a SQL database.")
+ "A connection to a SQL database."
:abstract t)
(cl-defgeneric emacsql-close (connection)
@@ -190,14 +190,12 @@ MESSAGE should not have a newline on the end."
;;; Helper mixin class
-(defclass emacsql-protocol-mixin ()
- ()
- (:documentation
- "A mixin for back-ends following the EmacSQL protocol.
+(defclass emacsql-protocol-mixin () ()
+ "A mixin for back-ends following the EmacSQL protocol.
The back-end prompt must be a single \"]\" character. This prompt
value was chosen because it is unreadable. Output must have
exactly one row per line, fields separated by whitespace. NULL
-must display as \"nil\".")
+must display as \"nil\"."
:abstract t)
(cl-defmethod emacsql-waiting-p ((connection emacsql-protocol-mixin))
