Skip to content

Commit 6f99023

Browse files
committed
Merge BlockstreamResearch#67: Hotfix docs
ba993b8 doc: Rename Simphony -> Simfony (Christian Lewe) 5d65ff4 doc: Remove outdated syntax (Christian Lewe) Pull request description: Remove misleading documentation and remove the old name "Simphony" from the codebase. ACKs for top commit: apoelstra: ACK ba993b8 Tree-SHA512: b817f34d110817646667a3479bc76c06a7484fdb4c03806055f9e97445c25b744601de36f01e8c4248d02ed8ef7029dda970aff3bad3751a9b650968f9220316
2 parents 7e59c47 + ba993b8 commit 6f99023

File tree

6 files changed

+8
-471
lines changed

6 files changed

+8
-471
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,6 @@ jet_verify(jet_eq_32(b, 7));
1818

1919
Take a look at the [example programs](https://github.com/BlockstreamResearch/simfony/tree/master/example_progs).
2020

21-
Learn about [Simfony's syntax](https://github.com/BlockstreamResearch/simfony/tree/master/doc/syntax.md). There is [experimental syntax](https://github.com/BlockstreamResearch/simfony/blob/master/doc/experimental-syntax.md) that is not supported by master yet.
22-
2321
## MSRV
2422

2523
This crate should compile with any feature combination on **Rust 1.61.0** or higher.

doc/context.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ A context Γ maps variable names to Simplicity types:
66

77
We write Γ(`v`) = A to denote that variable `v` has type A in context Γ.
88

9-
We handle free variables inside Simphony expressions via contexts.
9+
We handle free variables inside Simfony expressions via contexts.
1010

1111
If all free variables are defined in a context, then the context assigns a type to the expression.
1212

1313
We write Γ ⊩ `a`: A to denote that expression `a` has type A in context Γ.
1414

1515
Note that contexts handle only the **target type** of an expression!
1616

17-
Source types are handled by environments and the translation of Simphony to Simplicity.
17+
Source types are handled by environments and the translation of Simfony to Simplicity.
1818

1919
We write Γ ⊎ Δ to denote the **disjoint union** of Γ and Δ.
2020

doc/environment.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,13 @@ All expressions inside an environment share the same source type A. We say the e
1212
]
1313
```
1414

15-
We use environments to translate variables inside Simphony expressions to Simplicity.
15+
We use environments to translate variables inside Simfony expressions to Simplicity.
1616

1717
The environment tells us the Simplicity expression that returns the value of each variable.
1818

19-
We translate a Simphony program "top to bottom". Each time a variable is defined, we update the environment to reflect this change.
19+
We translate a Simfony program "top to bottom". Each time a variable is defined, we update the environment to reflect this change.
2020

21-
During the translation, we can ignore the source type of Simplicity expressions (translated Simphony expressions) entirely. We can focus on producing a Simplicity value of the expected target type. Environments ensure that we get input values for each variable that is in scope.
21+
During the translation, we can ignore the source type of Simplicity expressions (translated Simfony expressions) entirely. We can focus on producing a Simplicity value of the expected target type. Environments ensure that we get input values for each variable that is in scope.
2222

2323
Target types are handled by contexts.
2424

@@ -31,7 +31,7 @@ Ctx(Ξ)(`x`) = B if Ξ(`x`) = a: A → B
3131

3232
Patterns occur in let statements `let p := s`.
3333

34-
Pattern `p` binds the output of Simphony expression `s` to variables.
34+
Pattern `p` binds the output of Simfony expression `s` to variables.
3535

3636
As we translate `s` to Simplicity, we need an environment that maps the variables from `p` to Simplicity expressions.
3737

doc/experimental-syntax.md

Lines changed: 0 additions & 131 deletions
This file was deleted.

0 commit comments

Comments
 (0)