Infrastructure #22
Infrastructure #22
Conversation
fraya
commented
Jun 15, 2024
fraya
commented
- Basic update to infrastructure.
- Fix an error in test suite.
- Add documentation. Needs some love.
Closes dylan-lang#20
Closes dylan-lang#17
Update version and add sphinx-extensions as dependency to build the documentation.
|
|
||
| ```dylan | ||
| print-json(json-table, *standard-output*); | ||
| ``` |
There was a problem hiding this comment.
This needs to be print-json(json-table, *standard-output*, indent: 2) if you want it to pretty-print.
https://play.opendylan.org/shared/06af84b39fab129b is a complete working example. What do you think of starting to include Playground links like this in our documentation examples in general? At least until we can integrate the playground with the docs better?
There was a problem hiding this comment.
I wanted to use the simplest example but using indent: is ok too, since indenting will be the more common option.
I think is a good idea to use links to play.opendylan.org in the examples. I'll do it.
There was a problem hiding this comment.
Again, I'm not sure the API I created is very good. Probably defaulting to pretty-printing would have been better, and when someone realizes they want to optimize (e.g., because they're doing a JSON RPC) they could turn it off. Sigh.
documentation/source/index.rst
Outdated
| for machines to parse and generate. | ||
|
|
||
| The json library offers two primary methods to facilitate the | ||
| conversion between JSON strings and OpenDylan tables, making it |
There was a problem hiding this comment.
"OpenDylan tables" should be "Dylan data structures". e.g. parse-json("2") => 2
documentation/source/index.rst
Outdated
| @@ -0,0 +1,38 @@ | |||
| Welcome to Json's documentation! | |||
| ================================ | |||
There was a problem hiding this comment.
Since this will show up in the ToC sidebar it needs to be kept short, and should look like the rest of the docs, so just
json
====
(I'm fine with either upper or lower case since JSON is an acronym, but most package titles are lower case currently.)
documentation/source/index.rst
Outdated
|
|
||
| :gf:`parse-json` | ||
| This method takes a JSON-formatted string and converts it into an | ||
| OpenDylan table. This function is useful when you need to process |
There was a problem hiding this comment.
"OpenDylan" should be "Open Dylan" everywhere.
documentation/source/reference.rst
Outdated
| @@ -0,0 +1,189 @@ | |||
| Json library reference | |||
There was a problem hiding this comment.
is ok "Json Library Reference"?
There was a problem hiding this comment.
I think "Json" is a very odd capitalization for an acronym, but it's up to you.
documentation/source/reference.rst
Outdated
| .. code-block:: dylan | ||
|
|
||
| let data = """{"a": 1, "b": 2,}"""; | ||
| let parsed = parse-json(data); |
There was a problem hiding this comment.
I think this needs strict?: #f to work.
documentation/source/reference.rst
Outdated
| whitespace. If an integer, then use pretty printing and output | ||
| *indent* spaces for each indent level. | ||
|
|
||
| If `sort-keys:` is true, output object keys in lexicographical |
documentation/source/reference.rst
Outdated
|
|
||
| Override this to print your own objects in JSON format. It can be | ||
| implemented by converting objects to built-in Dylan types (tables, | ||
| collections, etc) and calling *print* on those objects, or by |
There was a problem hiding this comment.
"print" should be "print-json" here, I think.
Fix error in example and adds links to play.opendylan.org
Short title since this will show up in the ToC sidebar and it needs to be kept short, and should look like the rest of the docs.
