From 4a5d5c0d32e0c3dfb65be89ccb530715b6f230e0 Mon Sep 17 00:00:00 2001 From: Igor Matuszewski Date: Mon, 27 Nov 2023 23:19:07 +0100 Subject: [PATCH] Address feedback --- documentation/public/user-guide/introduction.md | 4 ++-- documentation/public/user-guide/overview.md | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/public/user-guide/introduction.md b/documentation/public/user-guide/introduction.md index e188ba802a..f1bd73f1f7 100644 --- a/documentation/public/user-guide/introduction.md +++ b/documentation/public/user-guide/introduction.md @@ -4,11 +4,11 @@ Slang is intended to be a modular Solidity compiler, specifically targeting code ## What Slang is not? -First and foremost, it is not a replacement to `solc`, the standard Solidity compiler. We do not plan at the moment to support emitting EVM bytecode. Secondly, it is not meant to be used for formal verification of contracts or Solidity logic in general. +First and foremost, it is not a replacement for `solc`, the standard Solidity compiler. We do not plan at the moment to support emitting EVM bytecode. Secondly, it is not meant to be used for formal verification of contracts or Solidity logic in general. ## Supporting multiple versions -Over the years, the Solidity programming language has evolved quite a bit since its inception. Some features were introduced, some changed, while some eventually became obsolete and were removed altogether. +The Solidity programming language has evolved quite a bit since its inception. Some features were introduced, some changed, while some eventually became obsolete and were removed altogether. While it's good for a programming language to evolve and better serve the needs of its users, not being able to easily upgrade or re-deploy existing contracts poses a unique challenge. Older contracts that are still being used on the blockchain, written in older versions of Solidity, must remain understandable during the development process. diff --git a/documentation/public/user-guide/overview.md b/documentation/public/user-guide/overview.md index 53cb145b37..8caee470a3 100644 --- a/documentation/public/user-guide/overview.md +++ b/documentation/public/user-guide/overview.md @@ -1,6 +1,6 @@ ## Design overview -At its core, Slang is a collection of APIs that is meant to analyze the source code, starting with the source code itself and ending with a rich structure that can be reasoned about. This is a departure from the classic approach of "black-box" compilers, which are handed the input and only their output can be observed. +At its core, Slang is a collection of APIs that are meant to analyze the source code, starting with the source code itself and ending with a rich structure that can be reasoned about. This is a departure from the classic approach of "black-box" compilers, which are handed the input and only their output can be observed. At the time of writing, Slang is capable of parsing the source code into a Concrete Syntax Tree (CST; also sometimes called "full-fidelity"), which is a tree structure of the program that also includes things like punctuation or whitespace.