[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[elpa] externals/srht 22ce5d1fd1 3/5: Clarify the doc string of srht-tok
From: |
ELPA Syncer |
Subject: |
[elpa] externals/srht 22ce5d1fd1 3/5: Clarify the doc string of srht-token and srht-username. |
Date: |
Mon, 6 Jun 2022 12:57:52 -0400 (EDT) |
branch: externals/srht
commit 22ce5d1fd1af8cdff0dcdbfdc7d70b312455d911
Author: Aleksandr Vityazev <avityazev@posteo.org>
Commit: Aleksandr Vityazev <avityazev@posteo.org>
Clarify the doc string of srht-token and srht-username.
* README: Clarify the Setup section.
* lisp/srht: Clarify the doc string of srht-token and srht-username.
---
README.md | 6 +++---
README.org | 7 +++----
lisp/srht.el | 5 +++--
3 files changed, 9 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 0d64eedbda..ea86535a81 100644
--- a/README.md
+++ b/README.md
@@ -35,9 +35,9 @@ installing it, place files from /lisp folder in `load-path`.
# Setup
-To use this client, you need to
[generate](https://meta.sr.ht/oauth/personal-token) a personal access token.
This token
-will have unrestricted access to all sr.ht APIs and can be used like a normal
-access token to authenticate API requests.
+To use this client, you need to
[generate](https://meta.sr.ht/oauth/personal-token) a personal access token
(Oauth not
+Oauth2). This token will have unrestricted access to all sr.ht APIs and can be
+used like a normal access token to authenticate API requests.
After creating the token:
diff --git a/README.org b/README.org
index 9a213e8ea6..ad51d12b01 100644
--- a/README.org
+++ b/README.org
@@ -29,10 +29,9 @@ guix package -f guix.scm
installing it, place files from /lisp folder in =load-path=.
* Setup
-
-To use this client, you need to
[[https://meta.sr.ht/oauth/personal-token][generate]] a personal access token.
This token
-will have unrestricted access to all sr.ht APIs and can be used like a normal
-access token to authenticate API requests.
+To use this client, you need to
[[https://meta.sr.ht/oauth/personal-token][generate]] a personal access token
(Oauth not
+Oauth2). This token will have unrestricted access to all sr.ht APIs and can be
+used like a normal access token to authenticate API requests.
After creating the token:
diff --git a/lisp/srht.el b/lisp/srht.el
index 4db9090179..dbc003d561 100644
--- a/lisp/srht.el
+++ b/lisp/srht.el
@@ -51,12 +51,13 @@
(if-let ((f (plist-get (car (auth-source-search :host "sr.ht"))
:secret)))
(funcall f) "")
- "Personal access token for Sourcehut instance."
+ "Personal access token for Sourcehut instance.
+It is necessary to use Oauth personal token not Oauth2."
:type 'string
:group 'srht)
(defcustom srht-username ""
- "Sourcehut username."
+ "Sourcehut username. May contain ~ or not, your choice."
:type 'string
:group 'srht)