branch: elpa/fedi
commit d6433ff59beb72f169c86efcda4c178f5e1352b7
Author: marty hiatt <martianhiatus [a t] riseup [d o t] net>
Commit: marty hiatt <martianhiatus [a t] riseup [d o t] net>
boilerplate + docstrings
---
fedi-http.el | 7 ++++---
fedi.el | 16 ++++++++--------
2 files changed, 12 insertions(+), 11 deletions(-)
diff --git a/fedi-http.el b/fedi-http.el
index 91e30b55062..e6b75fc528b 100644
--- a/fedi-http.el
+++ b/fedi-http.el
@@ -1,13 +1,14 @@
;;; fedi-http.el --- HTTP request/response functions -*- lexical-binding: t
-*-
-;; Copyright (C) 2020-2022 Marty Hiatt
+;; Copyright (C) 2020-2022 Marty Hiatt and mastodon.el authors
;; Author: Marty Hiatt <[email protected]>
-;; Version: 0.0.1
-;; Package-Requires: ((emacs "27.1"))
+;; Version: 0.0.2
;; Homepage: https://codeberg.org/martianh/fedi.el
;; This file is not part of GNU Emacs.
+;; This file is part of fedi.el
+
;; fedi-http.el is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
diff --git a/fedi.el b/fedi.el
index 1cac5d3a3ff..8fa95d56a24 100644
--- a/fedi.el
+++ b/fedi.el
@@ -1,8 +1,8 @@
-;;; fedi.el --- helper functions for fediverse clients -*- lexical-binding: t
-*-
+;;; fedi.el --- Helper functions for fediverse clients -*- lexical-binding: t
-*-
-;; Copyright (C) 2020-2022 Marty Hiatt
+;; Copyright (C) 2020-2022 Marty Hiatt and mastodon.el authors
;; Author: Marty Hiatt <[email protected]>
-;; Version: 0.0.1
+;; Version: 0.0.2
;; Package-Requires: ((emacs "27.1"))
;; Homepage: https://codeberg.org/martianh/fedi.el
@@ -47,8 +47,8 @@
"The URL of the instance to connect to.")
(defvar fedi-package-prefix nil
- "The name of your package, without following dash. Used to
-construct function names in `fedi-request'.")
+ "The name of your package, without following dash.
+Used to construct function names in `fedi-request'.")
(defmacro fedi-request
(method name endpoint &optional args params auth-param json headers)
@@ -69,16 +69,16 @@ name of your package, and set `fedi-instance-url' to the
URL of
an instance of your fedi service.
The name of functions generated with this will be the result of:
-(concat fedi-package-prefix \"-\" name).
+\(concat fedi-package-prefix \"-\" name).
The full URL for the endpoint is constructed by `fedi-http--api',
which see. ENDPOINT does not require a preceding slash.
For example, to make a GET request, called PKG-search to endpoint /search:
-(fedi-request \"get\" \"search\"
+\(fedi-request \"get\" \"search\"
\"search\" (query)
- `((\"q\" . ,query)))
+ \\=`((\"q\" . ,query)))
This macro doesn't handle authenticated requests, as these differ
between services. But you can easily wrap it in another macro
