Skip to content

Commit e28f7b9

Browse files
committed
Try to improve docs to address issue #58.
This library only supports JSON5 documents. It cannot parse everything that is legal JavaScript. For example, an object with an integer key is legal in JS, but not in JSON5. I've updated the text to reflect this.
1 parent 1f7f806 commit e28f7b9

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,10 @@ This is an early release. It has been reasonably well-tested, but it is
3131
**SLOW**. It can be 1000-6000x slower than the C-optimized JSON module,
3232
and is 200x slower (or more) than the pure Python JSON module.
3333

34+
**Please Note:** This library only handles JSON5 documents, it does not
35+
allow you to read arbitrary JavaScript. For example, bare integers can
36+
be legal object keys in JavaScript, but they aren't in JSON5.
37+
3438
## Known issues
3539

3640
* Did I mention that it is **SLOW**?
@@ -57,6 +61,11 @@ To run the tests, setup a venv and install the required dependencies with
5761

5862
## Version History / Release Notes
5963

64+
* v0.9.10 (2022-08-18)
65+
* [GitHub issue #58](https://github.com/dpranke/pyjson5/issues/58)
66+
Updated the //README.md to be clear that parsing arbitrary JS
67+
code may not work.
68+
* Otherwise, no code changes.
6069
* v0.9.9 (2022-08-01)
6170
* [GitHub issue #57](https://github.com/dpranke/pyjson5/issues/57)
6271
Fixed serialization for objects that subclass `int` or `float`:

json5/version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,4 +12,4 @@
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
1414

15-
VERSION = '0.9.9'
15+
VERSION = '0.9.10'

0 commit comments

Comments
 (0)