Docs for Clojure devs #109
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
holyjak
force-pushed
the
docs-wolf4devs
branch
from
dd3b730
to
9c764d6
Compare
This comment was marked as resolved.
This comment was marked as resolved.
holyjak
force-pushed
the
docs-wolf4devs
branch
3 times, most recently
from
90448c3
to
9194ace
Compare
This comment was marked as resolved.
This comment was marked as resolved.
holyjak
force-pushed
the
docs-wolf4devs
branch
2 times, most recently
from
24a6e6b
to
8d3964c
Compare
This comment was marked as outdated.
This comment was marked as outdated.
holyjak
force-pushed
the
docs-wolf4devs
branch
3 times, most recently
from
782798c
to
7847f4e
Compare
Added `wl/wolfram-expr` to make it easier to embed raw Wolfram inside a bigger Wolframite expression. Wrote "understanding-wolframite" to follow after the quick start for a deeper dive.
Issue: Before, we read these as keywords, and there was no support for translating them back to Wolfram. That made using them less convenient, we'd sometimes need to assign them an alias in Wolfram...
Fix: Parse them into records + add corresponding convert. For nice display, the single key of each such record has the same name as the type, so that they display as e.g. `{:Entity ["City" ...]}`.
* Understanding Wolframite: mention built-in doc helpers * wolfram-for-clojurians: Link to Wolfram syntax page too * + h.help!: Add support also for `:links` in add. to `:return-links` (easier to remember 😅)
…dvanced: syntax quote, move aliases further down.
as it prevents round-trips, i.e. using the value returned in next call (unless at the top level) and I can see no value in doing anything special here.
holyjak
force-pushed
the
docs-wolf4devs
branch
from
7847f4e
to
cb9efdd
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add Understanding Wolframite after the quickstart, and for devs: Brief introduction into Wolfram Language for Clojure developers + Wolframite for developers. Few improvements (help! supports :links, Entity[Property] is displayed better and supports round-trips, added wl/wolfram-expr).
Pls see individual commits.
Review tips: Skip anything in docs, look at changes in the existing notebooks + browse through the built site (e.g. running a local http server, such as
cd docs; python3 -m http.server 8000.It may be a good idea to delete docs/ and run
clojure -T:build build-siteto ensure it runs outside my PC too.