Skip to content

Commit

Permalink
misc grammar fixes
Browse files Browse the repository at this point in the history
numerous grammar fixes across the academy overview and chialisp intro as suggested by lgoldman
  • Loading branch information
BrandtH22 committed Oct 30, 2023
1 parent 01720d8 commit 8504071
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions docs/academy/academy-intro/academy-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,9 @@ While lessons are thoughtfully designed to facilitate learning, there are some c
## Knowledge check
Each lesson contains a brief self-assessment quiz designed to gauge learners' comprehension and retention of the video material. These assessments reinforce key concepts and help learners self-assess their understanding.

The quiz section has two components, questions and answers. The questions contain lesson applicable questions and the answers contain the corresponding answers.
The quiz section has two components, questions and answers. The questions contain lesson-applicable questions and the answers contain the corresponding answers.

Since this is a self assessment, you can of course skip the questions and go straight to the answers; but we strongly recommend that you take the time to solve the question on your own before checking the answer.
Since this is a self assessment, you can of course skip the questions and go straight to the answers; but, we strongly recommend that you take the time to solve the question on your own before checking the answer.

:::tip Question 1

Expand All @@ -73,7 +73,7 @@ What format is used for timestamps in the content scripts?

:::tip Question 2

What is the serialized form of this chialisp puzzle?
What is the serialized form of this Chialisp puzzle?

```chialisp
(mod (arg1 arg2) (+ arg1 arg2))
Expand All @@ -93,7 +93,7 @@ What is the serialized form of this chialisp puzzle?

:::tip Question 3

What is the chialisp puzzle for squaring a passed argument?
What is the Chialisp puzzle for squaring a passed argument?

:::

Expand Down
18 changes: 9 additions & 9 deletions docs/academy/chialisp/chialisp-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ slug: /chialisp-intro
---

## Content
In this lesson, we review the basics of Chialisp including syntax & structure, inequalities and if statements, and setting up a development environment.
In this lesson, we review the basics of Chialisp including syntax and structure, inequalities and if statements, and setting up a development environment.

<div class="videoWrapper">
<iframe width="896" height="504" src="https://www.youtube.com/embed/W9QK4PFIIpA" frameborder="0" allowfullscreen="allowfullscreen"></iframe>
Expand Down Expand Up @@ -72,17 +72,17 @@ In future videos we'll talk about smart coins signatures and inner puzzles. Than

## Common gotchas

- **run vs brun:** Run is used to serialize and run chialisp puzzles while brun is used to run clvm serialized puzzles generally when passing arguments.
- **Parentheses:** Chialisp is part of the fully parenthesized prefix notation programming language family tracing their [origins](https://en.wikipedia.org/wiki/Lisp_(programming_language)) to LISP 1 from the 1950s. One highly apparent aspect of these languages is their use of parenthesis to denote lists. It is recommended to use an IDE with proper syntax highlighting when writing these languages to ensure that all parenthesis are in the proper places. To help with this here is a [Chialisp language server extension](https://marketplace.visualstudio.com/items?itemName=ChiaNetwork.chialisp) for Visual Studio.
- **Prefix Notation:** Chialisp being part of the LISP family uses prefix notation. This means that the functions or operators appears first with their arguments following.
- **run vs brun:** Run is used to serialize and run Chialisp puzzles, while brun is used to run clvm serialized puzzles generally when passing arguments.
- **Parentheses:** Chialisp is part of the fully parenthesized prefix notation programming language family, tracing their [origins](https://en.wikipedia.org/wiki/Lisp_(programming_language)) to LISP 1 from the 1950s. One highly apparent aspect of these languages is their use of parenthesis to denote lists. It is recommended to use an IDE with proper syntax highlighting when writing these languages to ensure that all parenthesis are in the proper places. To help with this, here is a [Chialisp language server extension](https://marketplace.visualstudio.com/items?itemName=ChiaNetwork.chialisp) for Visual Studio.
- **Prefix Notation:** Chialisp being part of the LISP family uses prefix notation. This means that the functions or operators appear first with their arguments following.

---

## Knowledge check

:::tip Question 1 - Subtraction

What is a chialisp puzzle for subtracting two arguments?
What is a Chialisp puzzle for subtracting two arguments?

:::

Expand All @@ -100,7 +100,7 @@ What is a chialisp puzzle for subtracting two arguments?

:::tip Question 2 - Comparison

What is the serialized form of this chialisp puzzle?
What is the serialized form of this Chialisp puzzle?

```chialisp
(mod (arg1 arg2)
Expand Down Expand Up @@ -171,9 +171,9 @@ What is a Chialisp puzzle that performs the following?

### Links

- General [chialisp concepts](https://docs.chia.net/guides/chialisp-concepts): overviews of currying, inner puzzles, and morphing conditions.
- Guided [chialisp walkthroughs](https://docs.chia.net/guides/): guides for installation, creating smart coins, and working with BLS signatures.
- Chialisp [detailed documentation](https://chialisp.com/): detailed information on all aspects of chialisp.
- General [Chialisp concepts](https://docs.chia.net/guides/chialisp-concepts): overviews of currying, inner puzzles, and morphing conditions.
- Guided [Chialisp walkthroughs](https://docs.chia.net/guides/): guides for installation, creating smart coins, and working with BLS signatures.
- Chialisp [detailed documentation](https://chialisp.com/): detailed information on all aspects of Chialisp.
- Support [in discord](https://discord.gg/chia): for further support join our discord server and ask in the #chialisp or #support channels.

---

0 comments on commit 8504071

Please sign in to comment.