From 9df98091a366a3b1585ba52a21b0261b314ea8bd Mon Sep 17 00:00:00 2001 From: Sean Allred Date: Mon, 17 Nov 2014 08:45:09 -0500 Subject: Documentation -- part one Pushing this change to continue work elsewhere. --- sx-auth.el | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) (limited to 'sx-auth.el') diff --git a/sx-auth.el b/sx-auth.el index f32e7aa..96523f6 100644 --- a/sx-auth.el +++ b/sx-auth.el @@ -46,7 +46,26 @@ what you are doing!") Authentication is required to read your personal data (such as notifications) and to write with the API (asking and answering -questions)." +questions). + +When this function is called, `browse-url' is used to send the +user to an authorization page managed by StackExchange. The +following privileges are requested: + +* read_inbox + use SX to manage and visit items in your inbox + +* write_acesss + write comments, ask questions, and post answers on your + behalf + +* no_expiry + do not pester you to reauthorize again + +After authorization with StackExchange, the user is then +redirected to a website managed by SX. The access token required +to use authenticated methods is included in the hash (which is +parsed and displayed prominently on the page)." (interactive) (setq sx-auth-access-token -- cgit v1.2.3