Skip to content
This repository was archived by the owner on Mar 21, 2025. It is now read-only.

Commit b57021a

Browse files
committed
Some work on documentation.
1 parent 3f23990 commit b57021a

File tree

12 files changed

+43
-8
lines changed

12 files changed

+43
-8
lines changed

doc/installation.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,15 @@
11
# Installation
2+
3+
Celerity can be installed as a
4+
[.NET tool](https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools) in
5+
two ways:
6+
7+
* To install Celerity globally, run `dotnet tool install celerity -g`. This will
8+
allow you to run the `celerity` CLI driver anywhere, assuming you have
9+
[set up your `PATH` appropriately](https://learn.microsoft.com/en-us/dotnet/core/tools/global-tools#install-a-global-tool).
10+
* To install Celerity locally in a .NET-based project with a
11+
[tool manifest](https://learn.microsoft.com/en-us/dotnet/core/tools/local-tools-how-to-use#create-a-manifest-file),
12+
omit the `-g` option. This will require you to run `dotnet celerity` from the
13+
project directory.
14+
15+
<!-- TODO: Add more instructions once we publish signed binaries. -->
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Agents and Communication

doc/language/basic-concepts/agents-and-message-passing.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Modules and Code Reuse

doc/language/basic-concepts/modules-and-declarations.md

Lines changed: 0 additions & 1 deletion
This file was deleted.
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
# Optional Type Checking
2+
3+
<!-- TODO: Fill this out when we have a more concrete plan. -->
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Types and Values

doc/language/basic-concepts/values-and-types.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

doc/language/statements/expression-statement.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
expression-statement ::= expression
55
```
66

7-
Evaluates [`expression`](../expressions.md) (the *result*). If the expression
7+
Evaluates [`expression`](../expressions.md) (the *value*). If the expression
88
statement is the final statement of the enclosing
9-
[block expression](../expressions/block-expression.md), *result* becomes the
9+
[block expression](../expressions/block-expression.md), the *value* becomes the
1010
result of the block expression.

doc/language/types/special/any-type.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,13 @@
33
```ebnf
44
any-type ::= 'any'
55
```
6+
7+
`any` is a special type that, like [`unk`](unknown-type.md), allows any value.
8+
Unlike `unk`, however, `any` allows you to perform any operation on the value,
9+
even if the type checker would otherwise be able to prove that a given operation
10+
is incorrect.
11+
12+
The type of any operation on a value typed as `any` is also `any`. A value of
13+
type `any` can be assigned to a location of any other type.
14+
15+
`unk` should generally be preferred over `any` wherever possible.

0 commit comments

Comments
 (0)