Commit graph

33 commits

Author SHA1 Message Date
Ruud van Asseldonk
711e3191d5 Improve unpack and comprehension documentation 2025-12-14 19:31:20 +01:00
Ruud van Asseldonk
3008b99b41 De-emphasize deprecated |-operator in docs and examples 2025-11-22 21:44:36 +01:00
Ruud van Asseldonk
69e3c2947e Document that unpack combines with comprehensions 2025-11-22 21:33:24 +01:00
Ruud van Asseldonk
3baba9a382 Document unpack syntax
At first I put it after comprehensions, but if I put it before, then I
can use unpack in the comprehension example.
2025-11-22 21:33:24 +01:00
Ruud van Asseldonk
27c2c9cee3 Document assertion syntax change 2025-09-29 20:28:15 +02:00
Ruud van Asseldonk
3b7720940e Replace Int with Number in the docs
This is part of updating the implementation to have a single number type.
I have to admit, doing this, I'm hesitant again. I would really like len
functions to return Int, or to clarify in the types that std.range
accepts only integers. But let's experiment, implement this, and get a
feel for it before I make a call.
2025-02-24 20:42:59 +01:00
Ruud van Asseldonk
8cc1f263d8 Begin writing docs for the new Number type
I decided, after going through a few iterations of a blog post that
explains the trade-offs, to have only a single Number type, and to
remove Int. This is an invasive change, let's start with the docs
because those are somewhat easier.
2025-02-24 20:42:59 +01:00
Ruud van Asseldonk
684efd8a9b Write and extend some docs on numbers
I thought I was close to having a finished design, but re-reading what
I wrote before ... there are still some loose ends, like the comparison
operator now behaving very unexpectedly. Maybe I should ban cross-value
comparisons after all, and move that to a different function?
2025-02-24 20:42:59 +01:00
Ruud van Asseldonk
2601582abe Add std.empty_set constant
It started to get annoying to have to define it myself every time, so
let's just add it properly now. This also resolves the longstanding
issue in the RCL pretty-printer that we have no good way to print the
empty set -- now we do!
2024-12-07 20:26:40 +01:00
Ruud van Asseldonk
414b9c5051 Update docs to use new if-else syntax 2024-07-31 21:46:23 +02:00
Ruud van Asseldonk
45b545562b Stylize RCL consistently in small caps in docs
The diff here is best viewed with --word-diff.
2024-06-20 22:36:50 +02:00
Ruud van Asseldonk
6a3ec5c9f5 Document how to produce an empty set 2024-02-24 23:06:23 +01:00
Ruud van Asseldonk
e3c4929de5 Manage expectations a bit in the docs 2024-01-30 22:14:19 +01:00
Ruud van Asseldonk
48af30a813 Document dict indexing 2023-12-29 18:31:55 +01:00
Ruud van Asseldonk
be7d9dc637 Remove ':' after 'else' after all
After sleeping on it for a night, let's remove unnecessary syntax noise.
Add a friendly error in case a user writes the colon after all.
2023-12-29 13:23:54 +01:00
Ruud van Asseldonk
c48ec60f1a Update documentation for new if-else syntax
It turns out I did not document conditionals at all previously.
Add that then.
2023-12-29 13:19:45 +01:00
Ruud van Asseldonk
a40aa27db3 Bring operator documentation up to date 2023-12-22 20:41:41 +01:00
Ruud van Asseldonk
18226cafaa Document field access 2023-12-22 20:34:33 +01:00
Ruud van Asseldonk
3b5432bdf0 Document that negative list indices are allowed 2023-12-21 23:46:35 +01:00
Ruud van Asseldonk
ec96df570a Document functions in the manual 2023-11-30 19:45:26 +01:00
Ruud van Asseldonk
053ea258b2 Document that hyphen is allowed in identifiers 2023-11-28 18:53:51 +01:00
Ruud van Asseldonk
cbff42d3da Document new indexing support 2023-11-21 22:17:28 +01:00
Ruud van Asseldonk
878eaa4aa4 Use comma as the separator in record notation
I am still ambivalent about this. On the one hand I have a strong sense
that "key = value;" is a statement that needs a terminator. On the other
hand, it makes things more uniform to have only a single separator.

I think I just need to get used to the comma, and then I will not mind
so much. But let's see.
2023-10-21 10:43:44 +02:00
Ruud van Asseldonk
9df9d60b0e Write docs about how imports work
This also includes docs for the CLI for sandboxing modes, which at
this point are completely hypothetical, as well as relative and
workdir-relative import paths, which are also not implemented. One
might call it "readme-driven development".
2023-10-17 22:33:35 +02:00
Ruud van Asseldonk
66606915dd Document assertions and tracing 2023-09-27 00:28:02 +02:00
Ruud van Asseldonk
095678fe7d Enable syntax highlighting in docs examples 2023-09-24 22:16:57 +02:00
Ruud van Asseldonk
1b65d89fc1 Apply "dict" terminology consistently
So the type is dict, but we can have json notation for it, and record
notation, where the record notation has field identifiers. I think
that's a good compromise.
2023-09-24 12:54:54 +02:00
Ruud van Asseldonk
be73b4a2c2 Ensure {} is a dict, not a set
This fixes the json compatibility issue. Also update some terminology
from "record" to "dict" now that I'm touching things anyway.
2023-09-24 12:28:45 +02:00
Ruud van Asseldonk
9c77b466d9 Add reminder to fix json incompatibility
I just realized while reading through the docs, that we don't have a
choice about the meaning of {}, it has to be a dict, because it's a dict
in json.
2023-09-24 01:10:40 +02:00
Ruud van Asseldonk
4aff42a7c6 Document the comment syntax 2023-09-23 23:10:52 +02:00
Ruud van Asseldonk
a0f455f2d7 Update string docs in syntax chapter 2023-09-20 21:18:39 +02:00
Ruud van Asseldonk
cdcef562e5 Make docs a bit clearer 2023-08-14 00:27:15 +02:00
Ruud van Asseldonk
18c1e8133a Add basic initial documentation 2023-08-13 21:31:17 +02:00