Skip to content

Commit bbdfad4

Browse files
committed
Get ready for release 1.2.1
1 parent 411abf1 commit bbdfad4

File tree

5 files changed

+44
-14
lines changed

5 files changed

+44
-14
lines changed

CHANGES.rst

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,16 @@
11
CHANGES
22
=======
33

4+
1.2.1
5+
-----
6+
7+
* Add tables for operator precedence.
8+
* Start to add AMSLaTeX symbols. (A future release will finish this)
9+
* Revise ``README.rst``.
10+
* Some small corrections: ``Implies``
11+
* Make ``ujson`` optional
12+
13+
414
1.2.0
515
-----
616

README.rst

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,34 @@
22

33
|Packaging status|
44

5-
Mathics Scanner
6-
===============
5+
Mathics Character Tables and Scanner
6+
=====================================
77

8-
This is the tokeniser or scanner portion for the Wolfram Language.
8+
This repository really contains two things:
99

10-
As such, it also contains a full set of translation between Wolfram Language
11-
named characters, their Unicode/ASCII equivalents and code-points.
10+
* extensive tables describing WL symbols and operators their properties
11+
* a tokenizer or scanner portion for the Wolfram Language.
12+
13+
With respect to the first item, there is a commented YAML that contains a
14+
full set of translation between:
15+
16+
* Wolfram Language named characters,
17+
* their Unicode/ASCII equivalents and Unicode and WL code-points,
18+
* Operator name (if symbol is an operator),
19+
* Operator precedence (if an operator)
20+
* Keyboard escape sequences for the symbol
1221

1322
Uses
1423
----
1524

16-
This is used as the scanner inside `Mathics <https://mathics.org>`_ but it can
17-
also be used for tokenizing and formatting Wolfram Language code. In fact we
18-
intend to write one. This library is also quite usefull if you need to work
19-
with Wolfram Language named character and convert them to various formats.
25+
The scanner and character tables are used inside `Mathics <https://mathics.org>`_. However information can
26+
also be used by other programs for tokenizing and formatting Wolfram Language code.
27+
28+
For example, tables are used in `mathics-pygments <https://pypi.org/project/Mathics-Scanner/>`_, a Pygments-based
29+
lexer and highlighter for Mathematica/Wolfram Language source code.
30+
31+
This library may be useful if you need to work with Wolfram Language
32+
named character and convert them to various formats.
2033

2134
Usage
2235
-----
@@ -30,17 +43,24 @@ Usage
3043
``\[FormalA]``) and Wolfram's internal representation use the
3144
``m̀athics_scanner.characters.named_characters`` dictionary.
3245

33-
To regenerate scanner tables run:
46+
To regenerate JSON-format tables run:
3447

3548
::
3649

3750
$ mathics-generate-json-table
3851

52+
Without options ``mathics-generate-json-table`` produces the maximum set of correspondences.
53+
54+
In most applications though you may need just a few of these. The
55+
``--field`` option can be used to narrow the list of entries to output in JSON. Run
56+
``mathics-generate-json-table --help`` for a full list of fields.
57+
58+
3959
Implementation
4060
--------------
4161

4262
For notes on the implementation of the packages or details on the conversion
43-
scheme please read ``implementation.rst``.
63+
scheme please read `Implementation <https://mathics-scanner.readthedocs.io/en/latest/implementation.html>`_.
4464

4565
Contributing
4666
------------

mathics_scanner/data/characters.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

mathics_scanner/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@
55
# well as importing into Python. That's why there is no
66
# space around "=" below.
77
# fmt: off
8-
__version__ = "1.2.1.dev0" # noqa
8+
__version__="1.2.1" # noqa

setup.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ def subdirs(root, file="*.*", depth=10):
9797
zip_safe=False,
9898
# metadata for upload to PyPI
9999
maintainer="Mathics Group",
100-
description="A general-purpose computer algebra system.",
100+
description="Characters Tables and Tokenizer for Mathics and the Wolfram Language.",
101101
license="GPL",
102102
url="https://mathics.org/",
103103
keywords=["Mathematica", "Wolfram", "Interpreter", "Shell", "Math", "CAS"],

0 commit comments

Comments
 (0)