Skip to content

Commit

Permalink
Update & polish docs
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
dgw committed Jul 18, 2017
1 parent eb88733 commit cd37fcf
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 9 deletions.
13 changes: 5 additions & 8 deletions NEWS
Original file line number Diff line number Diff line change
Expand Up @@ -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"
-------------------------------------------
Expand Down
11 changes: 10 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
-----
Expand Down

0 comments on commit cd37fcf

Please sign in to comment.