Skip to content

Commit 60f1553

Browse files
committed
Warn about tabs
1 parent d8f34db commit 60f1553

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

analysis/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,9 @@ let a = 5
3939

4040
After building the ReScript project (**⚠️ this is a requirement**), you can execute `./rescript-editor-analysis.exe test Sample.res`, and completion will be executed for the cursor position indicated by `^`. The `com` directive requests completion. To see other commands, check out the pattern match in `test` in [Commands.ml](./src/Commands.ml).
4141

42+
> [!WARNING]
43+
> Ensure there are no spaces in the code comments, as the commands are captured by a regular expression that expects spaces and not tabs!
44+
4245
Here’s how it works: once a command is found in a comment, a copy of the source file is created inside a temporary directory, where the line above `^com` is uncommented. The corresponding analysis functionality is then processed, typically with `~debug:true`. With debug enabled, code paths like
4346

4447
```ml

0 commit comments

Comments
 (0)