From cd37fcfd66c963b694b6eb30ba3893e46c525379 Mon Sep 17 00:00:00 2001 From: dgw Date: Mon, 17 Jul 2017 19:32:00 -0500 Subject: [PATCH] Update & polish docs rST seems to require double backticks for code-formatted inline text, unlike Markdown (which only requires single). README describes all config options currently available now, not just the API key option. Also update/add ticket references to some recent NEWS entries, and remove entry for unpublished broken version 0.3.2. --- NEWS | 13 +++++-------- README.rst | 11 ++++++++++- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/NEWS b/NEWS index cbbce37..2380b22 100644 --- a/NEWS +++ b/NEWS @@ -9,22 +9,19 @@ Unreleased Added: -* Support for wolframalpha 3.0 with fallback to 2.4 (#11) -* New configuration option `max_public`, a number defining the maximum number of lines +* Support for wolframalpha 3.0 with transitional fallback to 2.4 (#11, #19; see README notes) +* New configuration option ``max_public``, a number defining the maximum number of lines that can be sent without using NOTICEs. Default: 5 (#13) * New configuration option ``units``, to specify whether the API should return ``metric`` (default) or ``nonmetric`` measurements (#18; see #16) -Updates: +Updated: * Threshold for using NOTICEs is now 5 lines, up from the previous default of 3 -sopel-wolfram v0.3.2 "Kimi ga omotteru yori" --------------------------------------------- - -Fixes: +Fixed: -* Non-ASCII text in output is no longer `\:encoded` (#15) +* Non-ASCII text in output is no longer ``\:encoded`` (#15) sopel-wolfram v0.3.1 "Nusumareta kuchibiru" ------------------------------------------- diff --git a/README.rst b/README.rst index 57deb45..62832ca 100644 --- a/README.rst +++ b/README.rst @@ -38,6 +38,9 @@ installations. Instead, to upgrade to the latest code, do:: Configuration ------------- +Required +:::::::: + The Wolfram\|Alpha API requires a key to be added in the bot’s config. Sign up for API access at http://developer.wolframalpha.com/portal/apisignup.html and add the App ID to Sopel’s configuration file: @@ -46,7 +49,13 @@ to Sopel’s configuration file: [wolfram] app_id = yourappidgoeshere - max_public = 5 + +Optional +:::::::: + +* ``max_public``: the number of lines over which results will be sent in NOTICE instead of + to the channel (default: 10) +* ``units``: the measurements to use in results, ``metric`` or ``nonmetric`` (needs wolframalpha 3.0) Usage -----