Skip to content

Commit 5b63b67

Browse files
vinzbarbutolhstrh
andauthored
Apply suggestions from code review
Co-authored-by: Marten Lohstroh <[email protected]>
1 parent f6f1662 commit 5b63b67

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/tools/code-extension.mdx

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ You can create a new LF package either manually by creating an LF file or by usi
2121
2. Save the file in a directory called `src` to ensure that generated code is placed in a parallel `src-gen` directory. For example, if your file is called `Foo.lf`, the directory structure after building will look like this:
2222

2323
```
24-
├── LF Package
24+
├── .
2525
│ ├── bin/
2626
│ │ └── Foo
2727
│ ├── src/
@@ -31,7 +31,7 @@ You can create a new LF package either manually by creating an LF file or by usi
3131
...
3232
```
3333

34-
Additionally, it's important to manually create the `Lingo.toml` file adjacent to the `src` folder in the root directory of the package.. This file serves as a configuration for the package, allowing you to specify the package name, version, and other metadata, including any dependencies you want to install.
34+
If you manually create the `Lingo.toml` file, place it adjacent to the `src` folder in the root directory of the package. This file serves as a configuration for the package, allowing you to specify the package name, version, and other metadata, including any dependencies you want to install.
3535

3636
#### Option 2: Create an LF Package Using the Lingo Package Manager
3737
1. After installing and configuring the Lingo Package Manager, create an empty folder with the desired name for the LF package.
@@ -41,7 +41,7 @@ Additionally, it's important to manually create the `Lingo.toml` file adjacent t
4141
This will set up a new LF package with the following structure:
4242

4343
```
44-
├── LF Package
44+
├── .
4545
│ ├── src/
4646
│ │ └── Main.lf
4747
└── └── Lingo.toml # Configuration file for current package
@@ -54,7 +54,7 @@ To open an existing LF package in VS Code, select the root directory of your Lin
5454
The correct structure of the LF package should look like this:
5555

5656
```
57-
├── root
57+
├── .
5858
│ ├── bin/
5959
│ ├── build/ # directory containing packages installed by Lingo Package Manager
6060
│ │ ├── lfc_include/ # Directory for storing reusable reactors
@@ -68,7 +68,7 @@ The correct structure of the LF package should look like this:
6868
└── └── Lingo.toml # Configuration file for Lingo Package Manager
6969
```
7070

71-
To correctly enable the [Package Explorer](#package-explorer), we recommend opening VS Code with the true root of your Lingua Franca package as your workspace. If the package structure deviates from the expected format, an error message will appear when opening the Package Explorer:
71+
To enable the [Package Explorer](#package-explorer), the workspace of your VS Code editor must be the root of a Lingua Franca package. If the workspace is not recognized as a valid Lingua Franca package, an error message will appear when opening the Package Explorer:
7272

7373
<Image img={error_message} style={{maxWidth: 400}} />
7474

@@ -90,7 +90,7 @@ Running the code can also be done from the VS Code terminal by executing the gen
9090
The **Lingua Franca Package Explorer** can be accessed by clicking on the **LF icon** in the activity bar on the left side of the screen. Once opened, the **Package Explorer** displays a **Tree View** with the following structure:
9191

9292
```
93-
├── LF Package
93+
├── <Package Name>
9494
│ ├── Installed Packages
9595
│ ├── Local Libraries
9696
└── └── Source Files
@@ -163,7 +163,7 @@ The **Import Selected Reactor** option is available only if an LF program is ope
163163
The **Local Libraries** section lists LF programs created by the developer, located in the `./src/lib/` directory. These programs serve as local libraries, containing reusable reactors. The directory structure follows this format:
164164

165165
```
166-
├── LF Package
166+
├── <Package Name>
167167
...
168168
│ ├── Local Libraries
169169
│ │ ├── File_1.lf
@@ -204,7 +204,7 @@ The **Import Selected Reactor** option is available only if an LF program is ope
204204
The **Source Files** section lists all LF programs in the `./src/` directory. This section provides direct access to the main source files of the package. The hierarchy for this view is straightforward:
205205

206206
```
207-
├── LF Package
207+
├── <Package Name>
208208
...
209209
│ ├── Local Libraries
210210
│ │ ├── File_1.lf
@@ -213,7 +213,7 @@ The **Source Files** section lists all LF programs in the `./src/` directory. Th
213213
...
214214
```
215215

216-
Clicking on any of the files will open the corresponding LF program in the editor, allowing developers to quickly navigate to and edit the source code of their package.
216+
Clicking on any of the files will open the corresponding LF program in the editor, providing a way to quickly navigate and edit the source code of a package.
217217

218218
## Notes
219219

0 commit comments

Comments
 (0)